【问题标题】:VS2008: Autogenerated files and XML documentationVS2008:自动生成的文件和 XML 文档
【发布时间】:2010-08-17 20:31:37
【问题描述】:
这是一个烦恼多于一个问题。我的项目包含许多自动生成的文件(使用 mgmtclassgen.exe)。当我生成 XML 文档时,我的精美注释库受到来自这些 autogen 文件的 xml 文档警告的困扰。
有没有办法 a) 禁止为这些文件生成文档或 b) 只为一组文件禁止警告 CS1591?我显然不想修改自动生成的文件,即使只是添加抑制编译指示。
库和生成的代码都在 C# 中,我使用的是 Visual Studio 2008。
【问题讨论】:
标签:
visual-studio
visual-studio-2008
documentation-generation
【解决方案1】:
AFAIK 您不能仅针对某些文件禁止此警告。如果这些警告真的让您感到困扰,您可以将自动生成的代码移动到一个单独的程序集中,您将为其禁用 XML 文档。
【解决方案2】:
您可以使用#pragma 指令禁用特定警告,这可能适合您的目的。禁用“缺少 xml 注释”警告的语法是:
#pragma warning disable 1591 // Disable 'missing xml comment' warning
您可以使用以下语法重新启用它:
#pragma warning restore 1591 // Restore 'missing xml comment' warning
这允许您有选择地忽略文件的一部分或整个文件的警告。