Share via

Documentatieregels

  • Artikel

Documentatieregels ondersteunen het schrijven van goed gedocumenteerde bibliotheken door het juiste gebruik van XML-documentatieopmerkingen voor extern zichtbare API's.

In deze sectie

Regel Beschrijving
CA1200: Vermijd het gebruik van cref-tags met een voorvoegsel Het kenmerk cref in een XML-documentatietag betekent 'codereferentie'. Hiermee wordt aangegeven dat de binnenste tekst van de tag een code-element is, zoals een type, methode of eigenschap. Vermijd het gebruik van cref tags met voorvoegsels, omdat dit voorkomt dat de compiler verwijzingen verifieert. Het voorkomt ook dat de Visual Studio Integrated Development Environment (IDE) deze symboolverwijzingen vindt en bijwerkt tijdens herstructureringen.