Freigeben über

Dokumentationsregeln

  • Artikel

Dokumentationsregeln unterstützen das Schreiben gut dokumentierter Bibliotheken mithilfe der richtigen Verwendung von XML-Dokumentationskommentaren für extern sichtbare APIs.

In diesem Abschnitt

Regel Beschreibung
CA1200: Vermeiden Sie die Verwendung von Cref-Tags mit einem Präfix Das cref Attribut in einem XML-Dokumentationstag bedeutet "Codeverweis". Es gibt an, dass der innere Text des Tags ein Codeelement ist, z. B. einen Typ, eine Methode oder eine Eigenschaft. Vermeiden Sie cref Tags mit Präfixen, da sie verhindert, dass der Compiler Verweise überprüft. Außerdem wird verhindert, dass die integrierte Visual Studio-Entwicklungsumgebung (IDE) diese Symbolverweise während der Umgestaltung findet und aktualisiert.