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:
@@ -7,12 +7,12 @@ using ZB.MOM.WW.ScadaBridge.Commons.Types.Scripts;
|
||||
namespace ZB.MOM.WW.ScadaBridge.ScriptAnalysis;
|
||||
|
||||
/// <summary>
|
||||
/// M3.1: a <b>compile-only</b> globals type that mirrors the real SiteRuntime
|
||||
/// A <b>compile-only</b> globals type that mirrors the real SiteRuntime
|
||||
/// <c>ScriptGlobals</c> (+ <c>ScriptRuntimeContext</c> helper surface)
|
||||
/// member-for-member, so a real instance / shared / on-trigger-handler script
|
||||
/// BINDS against it at design time. It is NEVER executed — every member body
|
||||
/// throws <see cref="NotSupportedException"/> or returns <c>default</c>. The
|
||||
/// design-time deploy gate (M3.5) compiles candidate scripts against this type
|
||||
/// design-time deploy gate compiles candidate scripts against this type
|
||||
/// via <see cref="RoslynScriptCompiler.Compile(string, Type, System.Collections.Generic.IEnumerable{Microsoft.CodeAnalysis.MetadataReference}, System.Collections.Generic.IEnumerable{string})"/>
|
||||
/// to catch undefined symbols and signature mismatches without touching the
|
||||
/// site runtime.
|
||||
|
||||
Reference in New Issue
Block a user