Zum Hauptinhalt springen
ai-slop/csharp-redundant-doc-commentmanuelle Behebung

Redundanter XML-Doc-Kommentar.

Ein einzeiliges `/// <summary>Gets or sets the name.</summary>`, das den Member-Namen wiederholt. Es dokumentiert nichts, was die Signatur nicht schon sagt.

Beanstandete und saubere Form.

Jedes Beispiel zeigt genau die Codeform, nach der die Regel sucht, und dann die kleinste Version, die die Absicht bewahrt, ohne Risiken zu verstecken oder Rauschen hinzuzufügen.

csharp-redundant-doc-comment.cs
✗ Beanstandet
/// <summary>Gets or sets the timeout.</summary>
public int Timeout { get; set; }

/// <summary>Gets the name.</summary>
public string Name { get; }
Warum das anschlägt

Deterministischer Zeilenabgleich: beanstandet ein einzeiliges `/// <summary>...</summary>`, dessen Text mit Gets, Sets, Gets or sets, The, A oder An beginnt und nur Wörter enthält.

csharp-redundant-doc-comment.cs
✓ Sauber
/// <summary>Request timeout in milliseconds; must be greater than zero.</summary>
public int Timeout { get; set; }

public string Name { get; }
Was sich geändert hat

Lösch den Boilerplate oder ersetze ihn durch das, was die Signatur nicht sagen kann: Einheiten, Invarianten, gültige Wertebereiche oder Seiteneffekte.

Agenten versehen jeden public Member mit Standard-XML-Docs, um gründlich zu wirken. Der Vorlagentext fügt keine Bedeutung hinzu und veraltet, wenn sich Member ändern.

Wie diese Regel begründet ist.

Regel-ID

ai-slop/csharp-redundant-doc-comment

Prüfende Engine

ai-slop

Erkennungsstrategie

Deterministischer Zeilenabgleich: beanstandet ein einzeiliges `/// <summary>...</summary>`, dessen Text mit Gets, Sets, Gets or sets, The, A oder An beginnt und nur Wörter enthält.

Legitimer Code, der NICHT beanstandet wird

Summaries mit erklärenden Wörtern wie because, since, must, when, unless, avoid oder note, Summaries mit anderer Interpunktion und mehrzeilige `<summary>`-Blöcke werden nicht beanstandet.

Belege

Teil des C#-Regelsatzes von aislop. Vollwertige C#-Unterstützung, einschließlich C#-spezifischer AI-Slop-Regeln, kam mit aislop v0.14.1.