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:
@@ -15,7 +15,7 @@ public class DataConnectionOptions
|
||||
public TimeSpan WriteTimeout { get; set; } = TimeSpan.FromSeconds(30);
|
||||
|
||||
/// <summary>
|
||||
/// DataConnectionLayer-027: per-tag timeout applied to each <see cref="IDataConnection.ReadAsync"/>
|
||||
/// Per-tag timeout applied to each <see cref="IDataConnection.ReadAsync"/>
|
||||
/// call on the initial-subscribe seed path (and reconnect re-seed). A hung device read would
|
||||
/// otherwise delay <c>SubscribeCompleted</c> and its acknowledgement indefinitely. On timeout
|
||||
/// the tag is treated the same as any other failed seed read — it stays in the pending set and
|
||||
@@ -27,12 +27,12 @@ public class DataConnectionOptions
|
||||
/// <summary>
|
||||
/// Minimum time a connection must stay up before it is considered stable.
|
||||
/// If a connection drops before this threshold, it counts as an unstable
|
||||
/// disconnect toward the failover retry count (DataConnectionLayer-009).
|
||||
/// disconnect toward the failover retry count.
|
||||
/// </summary>
|
||||
public TimeSpan StableConnectionThreshold { get; set; } = TimeSpan.FromSeconds(60);
|
||||
|
||||
/// <summary>
|
||||
/// DataConnectionLayer-027: total number of attempts the seed read makes per tag
|
||||
/// Total number of attempts the seed read makes per tag
|
||||
/// before giving up. The initial subscribe seed (and the reconnect re-seed) reads
|
||||
/// each just-advised tag to capture its current value; on a cold/fresh advise the
|
||||
/// read can race the subscription and return an empty/failed result. A STATIC tag
|
||||
@@ -44,7 +44,7 @@ public class DataConnectionOptions
|
||||
public int SeedReadMaxAttempts { get; set; } = 3;
|
||||
|
||||
/// <summary>
|
||||
/// DataConnectionLayer-027: delay between seed-read attempts for the tags that have
|
||||
/// Delay between seed-read attempts for the tags that have
|
||||
/// not yet returned a usable value. Applied once per round across the whole pending
|
||||
/// subset, so the total added latency is bounded to
|
||||
/// <c>(SeedReadMaxAttempts - 1) × SeedReadRetryDelay</c> regardless of tag count.
|
||||
|
||||
Reference in New Issue
Block a user