Dokumentationsregeln

  • Artikel

Dokumentationsregeln unterstützen das Schreiben von gut dokumentierten Bibliotheken durch die ordnungsgemäße Verwendung von XML-Dokumentationskommentaren für extern sichtbare APIs.

In diesem Abschnitt

Regel Beschreibung
CA1200: Verwenden Sie keine cref-Tags mit einem Präfix. Das Attribut cref in einem XML-Dokumentationstag steht für „Code reference“ (Codeverweis). Es gibt an, dass der innere Text des Tags ein Codeelement ist, wie z.B. ein Typ, eine Methode oder Eigenschaft. Verwenden Sie keine cref-Tags mit Präfixen, da diese verhindern, dass der Compiler Referenzen überprüfen kann. Außerdem wird dadurch verhindert, dass die integrierte Entwicklungsumgebung (IDE) von Visual Studio diese Symbolverweise beim Refactoring findet und aktualisiert.