J'ai un projet avec plus de 500 Missing XML Comment des avertissements. Je sais que je peux supprimer la fonction Commentaire XML ou coller des extraits de commentaires vides partout, mais je préférerais une solution générique qui me permettrait d'effectuer une seule modification pour désactiver tous les avertissements de ce type.
Ce que je fais en ce moment, c'est mettre
///<Summary>
///
///</Summary>ou
#pragma warning disable 1591J'étais juste curieux de savoir si c'était possible.
Visual Studio 2022 :
Je recommande d'utiliser .editorconfig dans Visual Studio pour définir un style de code commun à toutes les solutions.
Dans ce cas, il suffit d'ajouter ce code manuellement dans le fichier .editorconfig fichier :
# SA0001: XML comment analysis is disabled due to project configuration
dotnet_diagnostic.SA0001.severity = noneNOTE : Pour moi, supprimer SA0001 à partir de l'éditeur Config designer ne fonctionne pas.
Seule la règle du réglage manuel figure dans le dossier.
Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.
3 votes
Quelle est la question réelle ? Voulez-vous connaître un autre moyen de désactiver les avertissements qui sont générés lorsque les commentaires XML sont manquants ? Dans les propriétés du projet, allez dans l'onglet "Build" et décochez "Fichier de documentation XML". Cependant, je vous suggère de ne pas supprimer les avertissements mais d'ajouter la documentation manquante.
0 votes
C'est tout à fait correct, mais j'étais juste curieux de savoir si nous pouvions résoudre ce problème à partir d'un seul endroit, car je suis novice en la matière.
0 votes
Ces questions connexes peuvent vous aider : stackoverflow.com/questions/11444631/ stackoverflow.com/questions/3630282/
1 votes
L'avertissement n'apparaît que pour les membres qui sont visibles par d'autres assemblées. Souvent, les gens font des classes (et des interfaces, des enums, etc.)
publicsans raison valable. Dans ce cas, une solution facile (et à mon avis bonne) consiste à supprimer le motpublic(ou le remplacer par une redondanteinternalselon le style préféré) à partir du type le plus extérieur. Tous les avertissements CS1591 concernant ce type et ses membres disparaissent alors. Bien sûr, vous devrez peut-être encore conserver un peu de typespublic. Mais dans ce cas, il est juste que vous exigiez de documenter correctement leurs parties publiques.