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:
@@ -20,7 +20,7 @@ namespace ZB.MOM.WW.ScadaBridge.ClusterInfrastructure;
|
||||
/// </summary>
|
||||
public class ClusterOptions
|
||||
{
|
||||
// ClusterInfra-011: the previous `public const string SectionName = "ScadaBridge:Cluster";`
|
||||
// The previous `public const string SectionName = "ScadaBridge:Cluster";`
|
||||
// was documented as "single source of truth so binding sites do not hard-code the
|
||||
// magic string" but no caller ever read it — the Host's SiteServiceRegistration and
|
||||
// StartupValidator both hard-code the literal directly. Wiring those binding sites
|
||||
|
||||
@@ -3,7 +3,7 @@ using ZB.MOM.WW.Configuration;
|
||||
namespace ZB.MOM.WW.ScadaBridge.ClusterInfrastructure;
|
||||
|
||||
/// <summary>
|
||||
/// CI-004: Validates <see cref="ClusterOptions"/> at startup. The values it
|
||||
/// Validates <see cref="ClusterOptions"/> at startup. The values it
|
||||
/// guards carry cluster-wide consequences — the design doc
|
||||
/// (<c>Component-ClusterInfrastructure.md</c>) is emphatic that misconfiguring
|
||||
/// them produces a total cluster shutdown or an indefinitely blocked singleton.
|
||||
@@ -21,7 +21,7 @@ public sealed class ClusterOptionsValidator : OptionsValidatorBase<ClusterOption
|
||||
/// <inheritdoc />
|
||||
protected override void Validate(ValidationBuilder builder, ClusterOptions options)
|
||||
{
|
||||
// CI-012: design doc states "both nodes are seed nodes — each node lists
|
||||
// The design doc states "both nodes are seed nodes — each node lists
|
||||
// both itself and its partner" so a properly-configured deployment lists
|
||||
// two. Accepting a single-seed configuration silently defeats the
|
||||
// "no startup ordering dependency" guarantee called out by
|
||||
|
||||
@@ -31,11 +31,11 @@ public static class ServiceCollectionExtensions
|
||||
return services;
|
||||
}
|
||||
|
||||
// ClusterInfra-014: the previous `AddClusterInfrastructureActors` extension
|
||||
// The previous `AddClusterInfrastructureActors` extension
|
||||
// was dead surface — its XML doc told callers "do not call", its body
|
||||
// unconditionally threw `NotImplementedException`, and no production caller
|
||||
// existed anywhere in the solution (verified by grep). The CI-002
|
||||
// "throw loudly" decision was made while CI-001's ownership question was
|
||||
// existed anywhere in the solution (verified by grep). The
|
||||
// "throw loudly" decision was made while the ownership question was
|
||||
// still open; that question is now permanently settled by the
|
||||
// "Implementation Note — Code Placement" section of
|
||||
// Component-ClusterInfrastructure.md, which records that all actor wiring
|
||||
|
||||
Reference in New Issue
Block a user