docs(comments): strip internal task/milestone/bundle bookkeeping from code comments
Remove project bookkeeping citations from shipped code comments across the solution: hyphenated task IDs (WP-14, StoreAndForward-025), milestone/task/ issue refs (M3, Task 4, Audit Log #23, #21), Bundle X task-bundle labels, and C/D/K/S/T phase labels. Comment text only — no code logic, string/log literals, or XML-doc structure changed. Genuine descriptions are preserved (only the citation is stripped), and technical lookalikes are retained (UTF-8, SHA-256, T00:00:00, M365, UTC-5, pre-C4/pre-C5 schema versions). Flagged by the new CommentChecker TaskReferenceInComment / TrackingReferenceInComment checks plus targeted grep passes; full solution builds clean, append-only guard tests pass.
This commit is contained in:
@@ -6,14 +6,14 @@ namespace ZB.MOM.WW.ScadaBridge.CentralUI.Services;
|
||||
|
||||
/// <summary>
|
||||
/// Flattened, typed view of a canonical <see cref="ZB.MOM.WW.Audit.AuditEvent"/> for the
|
||||
/// Central UI audit pages. C3 (Task 2.5) made the canonical record the seam type — the
|
||||
/// Central UI audit pages. The canonical record is the seam type — the
|
||||
/// query service decomposes it into this view (via <see cref="AuditRowProjection"/>) so the
|
||||
/// existing razor bindings (<c>row.Channel</c>, <c>Event.Status</c>, <c>evt.RequestSummary</c>,
|
||||
/// …) keep working against typed properties rather than parsing <c>DetailsJson</c> inline.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This is presentation-only: it carries the same field surface the bespoke
|
||||
/// <c>Commons.Entities.Audit.AuditEvent</c> exposed before C3. <c>ForwardState</c> is always
|
||||
/// <c>Commons.Entities.Audit.AuditEvent</c> exposed previously. <c>ForwardState</c> is always
|
||||
/// null on the central read path (it is site-storage-only and not carried on canonical rows).
|
||||
/// </remarks>
|
||||
public sealed record AuditEventView
|
||||
|
||||
Reference in New Issue
Block a user