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

Question

C’est plus une gêne qu’un problème. Mon projet contient un certain nombre de fichiers générés automatiquement (à l'aide de mgmtclassgen.exe). Lorsque je génère la documentation XML, ma bibliothèque admirablement commentée est en proie aux avertissements de la documentation XML à partir de ces fichiers autogen.

Existe-t-il un moyen de supprimer la documentation générée pour ces fichiers ou de supprimer l’avertissement CS1591 uniquement pour un ensemble de fichiers? Je ne souhaite évidemment pas modifier les fichiers générés automatiquement, même s'il ne s'agit que d'ajouter des pragmas de suppression.

La bibliothèque et le code généré sont tous deux en C # et j'utilise Visual Studio 2008.

Answer 1

Autant que je sache, vous ne pouvez pas supprimer cet avertissement uniquement pour certains fichiers. Si ces avertissements vous dérangent vraiment, vous pouvez déplacer le code généré automatiquement vers un assemblage distinct pour lequel vous souhaitez désactiver la documentation XML.

Answer 2

Vous pouvez désactiver des avertissements spécifiques à l'aide de la directive #pragma. Cela peut vous convenir. La syntaxe permettant de désactiver l'avertissement de "commentaire xml manquant" est la suivante:

#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

Ceci vous permet d'ignorer sélectivement les avertissements pour une partie d'un fichier ou pour un fichier complet.