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,7 +6,7 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Kpi;
|
||||
namespace ZB.MOM.WW.ScadaBridge.AuditLog.Kpi;
|
||||
|
||||
/// <summary>
|
||||
/// Audit Log (#23) M6 "KPI History & Trends" (K8) — the
|
||||
/// "KPI History & Trends" — the
|
||||
/// <see cref="IKpiSampleSource"/> for the <see cref="KpiSources.AuditLog"/> source.
|
||||
/// The central recorder singleton enumerates this provider once per sampling pass
|
||||
/// and persists its samples into the central <c>KpiSample</c> history table.
|
||||
@@ -38,7 +38,7 @@ public sealed class AuditLogKpiSampleSource : IKpiSampleSource
|
||||
|
||||
// Metric catalog — the exact strings persisted in KpiSample.Metric. All three are
|
||||
// charted, so they share the public Commons catalog: source + UI trend page key off
|
||||
// one symbol (#178). Stable identifiers; do not rename (values are persisted).
|
||||
// one symbol. Stable identifiers; do not rename (values are persisted).
|
||||
private const string TotalEventsLastHourMetric = KpiMetrics.AuditLog.TotalEventsLastHour;
|
||||
private const string ErrorEventsLastHourMetric = KpiMetrics.AuditLog.ErrorEventsLastHour;
|
||||
private const string BacklogTotalMetric = KpiMetrics.AuditLog.BacklogTotal;
|
||||
|
||||
Reference in New Issue
Block a user