VS2008:自动生成的文件和XML文档

时间:2009-09-18 16:57:02

标签: visual-studio visual-studio-2008 documentation-generation

这不仅仅是一个烦恼。我的项目包含许多自动生成的文件(使用mgmtclassgen.exe)。当我生成XML文档时,我精美评论的库受到来自这些autogen文件的xml文档警告的困扰。

有没有办法要么a)抑制这些文件的生成文档,要么b)仅针对一组文件禁止警告CS1591?我显然不想修改自动生成的文件,即使只是添加抑制编译指示。

库和生成的代码都在C#中,我使用的是Visual Studio 2008。

2 个答案:

答案 0 :(得分:1)

AFAIK您无法仅对某些文件禁止此警告。如果这些警告确实困扰您,您可以将自动生成的代码移动到您将禁用XML文档的单独程序集。

答案 1 :(得分:0)

您可以使用#pragma指令禁用特定警告,这可能适合您的目的。禁用“缺少xml注释”警告的语法是:

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

您可以使用以下语法重新启用它:

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

这允许您有选择地忽略文件的任何部分或完整文件的警告。