VS2008: Fichiers générés automatiquement et documentation XML

Question

Il s'agit d'une nuisance plus qu'un problème. Mon projet contient un certain nombre de fichiers générés automatiquement (en utilisant mgmtclassgen.exe). Lorsque je génère la documentation XML, ma bibliothèque magnifiquement commentée est en proie à des avertissements de documentation xml provenant de ces fichiers autogen.

Existe-t-il un moyen a) de supprimer la génération de documentation pour ces fichiers ou b) de supprimer l'avertissement CS1591 uniquement pour un ensemble de fichiers? Je ne veux évidemment pas modifier les fichiers qui sont générés automatiquement, même si pour ajouter des pragmas de suppression.

La bibliothèque et le code généré sont à la fois en C# et je suis en utilisant Visual Studio 2008.

Answer 1

AFAIK vous ne pouvez pas supprimer cet avertissement seulement pour certains fichiers. Vous pouvez, si ces avertissements vous dérangent vraiment, déplacer le code généré automatiquement vers un assembly séparé pour lequel vous désactivez la documentation XML.

Answer 2

Vous pouvez désactiver des avertissements spécifiques à l'aide de la directive #pragma, cela peut convenir à votre objectif. La syntaxe pour désactiver l'avertissement « manquant commentaire xml » est:

#pragma warning disable 1591 // Disable 'missing xml comment' warning 

Vous pouvez le réactiver en utilisant la syntaxe suivante:

#pragma warning restore 1591 // Restore 'missing xml comment' warning 

Cela vous permet d'ignorer de manière sélective des avertissements pour une ou l'autre partie d'un fichier ou un fichier complet.