Règles de documentation

  • Article

Les règles de documentation aident à écrire des bibliothèques bien documentées en utilisant correctement des commentaires de documentation XML pour les API visibles en externe.

Contenu de cette section

Règle Description
CA1200 : Éviter d’utiliser des balises cref avec un préfixe L’attribut cref dans une balise de documentation XML signifie « référence de code ». Il indique que le texte interne de la balise est un élément de code tel qu’un type, une méthode ou une propriété. Évitez d’utiliser les balises cref avec des préfixes, car cela empêche le compilateur de vérifier les références. Cela empêche également l’environnement de développement intégré (IDE) de Visual Studio de rechercher et de mettre à jour ces références de symboles pendant les refactorisations.