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:
@@ -8,7 +8,7 @@ namespace ZB.MOM.WW.ScadaBridge.Commons.Messages.DebugView;
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// <b>Additive-only contract (M2.11):</b> <see cref="InstanceNotFound"/> is an
|
||||
/// <b>Additive-only contract:</b> <see cref="InstanceNotFound"/> is an
|
||||
/// optional trailing parameter with a default of <see langword="false"/> so every
|
||||
/// existing positional constructor call and every existing serialized wire frame
|
||||
/// remains valid. Callers that receive a snapshot with
|
||||
@@ -33,7 +33,7 @@ public record DebugViewSnapshot(
|
||||
IReadOnlyList<AttributeValueChanged> AttributeValues,
|
||||
IReadOnlyList<AlarmStateChanged> AlarmStates,
|
||||
DateTimeOffset SnapshotTimestamp,
|
||||
// M2.11 — additive field: true when the requested instance is not registered
|
||||
// Additive field: true when the requested instance is not registered
|
||||
// on this site. Defaults to false so all existing call sites and wire
|
||||
// frames are unaffected.
|
||||
bool InstanceNotFound = false);
|
||||
|
||||
Reference in New Issue
Block a user