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,8 +6,8 @@ namespace ZB.MOM.WW.ScadaBridge.ManagementService;
|
||||
|
||||
/// <summary>
|
||||
/// Flat, wire-shape view of a canonical <see cref="ZB.MOM.WW.Audit.AuditEvent"/> for the
|
||||
/// management CLI's <c>/api/audit/query</c> + <c>/api/audit/export</c> endpoints. C3
|
||||
/// (Task 2.5) made the canonical record the repository seam type; this DTO preserves the
|
||||
/// management CLI's <c>/api/audit/query</c> + <c>/api/audit/export</c> endpoints. The
|
||||
/// canonical record was later made the repository seam type; this DTO preserves the
|
||||
/// existing 24-field JSON/CSV shape the CLI consumes by decomposing the canonical row
|
||||
/// (via <see cref="AuditRowProjection"/>) at the endpoint boundary.
|
||||
/// </summary>
|
||||
|
||||
Reference in New Issue
Block a user