Regole della documentazione
Le regole della documentazione supportano la scrittura di librerie ben documentate tramite l'uso corretto dei commenti della documentazione XML per le API visibili esternamente.
Regola | Descrizione |
---|---|
CA1200: Evitare l'uso di tag cref con un prefisso | L'attributo cref in un tag di documentazione XML significa "riferimento al codice". Specifica che il testo all'interno del tag è un elemento di codice, ad esempio un tipo, un metodo o una proprietà. Evitare di usare cref tag con prefissi, perché impedisce al compilatore di verificare i riferimenti. Impedisce inoltre all'ambiente di sviluppo integrato (IDE) di Visual Studio di trovare e aggiornare questi riferimenti ai simboli durante il refactoring. |
Feedback su .NET
.NET è un progetto di open source. Selezionare un collegamento per fornire feedback: