Delen via


Documentatieregels

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

In deze sectie

Regel Beschrijving
CA1200: Vermijd het gebruik van creftags met een voorvoegsel Het kenmerk cref in een XML-documentatietag betekent 'codereferentie'. Hiermee geeft u op 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 hiermee wordt voorkomen dat de compiler verwijzingen verifieert. Het voorkomt ook dat de IDE (Integrated Development Environment) van Visual Studio deze symboolverwijzingen tijdens herstructureringen kan vinden en bijwerken.