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:
@@ -14,7 +14,7 @@ using System.Text.Json;
|
||||
namespace ZB.MOM.WW.ScadaBridge.SiteRuntime.Actors;
|
||||
|
||||
/// <summary>
|
||||
/// WP-15: Script Actor — coordinator actor, child of Instance Actor.
|
||||
/// Script Actor — coordinator actor, child of Instance Actor.
|
||||
/// Holds compiled script delegate, manages trigger configuration, and spawns
|
||||
/// ScriptExecutionActor children per invocation. Does not block on child completion.
|
||||
///
|
||||
@@ -45,7 +45,7 @@ public class ScriptActor : ReceiveActor, IWithTimers
|
||||
private TimeSpan? _minTimeBetweenRuns;
|
||||
|
||||
/// <summary>
|
||||
/// M2.5 (#9): the per-script execution timeout in seconds, or null to use the
|
||||
/// The per-script execution timeout in seconds, or null to use the
|
||||
/// global default. Threaded down to each spawned <see cref="ScriptExecutionActor"/>,
|
||||
/// which applies <c>perScript ?? global</c> (and treats ≤ 0 as "use global").
|
||||
/// </summary>
|
||||
@@ -69,7 +69,7 @@ public class ScriptActor : ReceiveActor, IWithTimers
|
||||
private const string WhileTrueTimerKey = "whiletrue-trigger";
|
||||
|
||||
/// <summary>
|
||||
/// SiteRuntime-017: the exact dictionary instance this actor was seeded from
|
||||
/// The exact dictionary instance this actor was seeded from
|
||||
/// at construction. The Instance Actor must pass a private snapshot here, not
|
||||
/// its live <c>_attributes</c> field — sharing the live dictionary lets this
|
||||
/// constructor enumerate it while the Instance Actor mutates it on another
|
||||
@@ -207,9 +207,9 @@ public class ScriptActor : ReceiveActor, IWithTimers
|
||||
return;
|
||||
}
|
||||
|
||||
// Audit Log #23 (ParentExecutionId): carry any inbound-routed
|
||||
// ParentExecutionId through to the ScriptExecutionActor so the routed
|
||||
// script's ScriptRuntimeContext can record its spawner. Null for normal
|
||||
// (ParentExecutionId): carry any inbound-routed ParentExecutionId
|
||||
// through to the ScriptExecutionActor so the routed script's
|
||||
// ScriptRuntimeContext can record its spawner. Null for normal
|
||||
// (tag-change / timer) runs and nested Script.Call invocations.
|
||||
SpawnExecution(
|
||||
request.Parameters, request.CurrentCallDepth, Sender, request.CorrelationId,
|
||||
@@ -413,7 +413,7 @@ public class ScriptActor : ReceiveActor, IWithTimers
|
||||
{
|
||||
var executionId = $"{_scriptName}-exec-{_executionCounter++}";
|
||||
|
||||
// SiteRuntime-009: the actor's mailbox stays on the default dispatcher, but the
|
||||
// The actor's mailbox stays on the default dispatcher, but the
|
||||
// script body itself runs on the dedicated ScriptExecutionScheduler (a bounded
|
||||
// set of dedicated threads), so blocking script I/O is contained there and
|
||||
// cannot starve the shared .NET thread pool.
|
||||
@@ -432,10 +432,10 @@ public class ScriptActor : ReceiveActor, IWithTimers
|
||||
_scope,
|
||||
_healthCollector,
|
||||
_serviceProvider,
|
||||
// Audit Log #23 (ParentExecutionId): null for trigger-driven runs;
|
||||
// (ParentExecutionId): null for trigger-driven runs;
|
||||
// an inbound-API-routed call supplies the inbound request's id.
|
||||
parentExecutionId,
|
||||
// M2.5 (#9): per-script timeout override (null = use global).
|
||||
// Per-script timeout override (null = use global).
|
||||
_executionTimeoutSeconds));
|
||||
|
||||
Context.ActorOf(props, executionId);
|
||||
@@ -455,7 +455,7 @@ public class ScriptActor : ReceiveActor, IWithTimers
|
||||
try
|
||||
{
|
||||
// Use InvariantCulture so a string attribute value like "1.5" parses
|
||||
// consistently regardless of the host locale (SiteRuntime-023). For
|
||||
// consistently regardless of the host locale. For
|
||||
// purely-numeric inputs the culture argument is a no-op, but it is
|
||||
// safe and future-proof for string-typed attribute values arriving
|
||||
// from scripts or the data connection layer.
|
||||
|
||||
Reference in New Issue
Block a user