禁止XML注释的警告

(不是我的作品，但我发现它很有用，所以我包含了文章和链接)

http://bernhardelbl.wordpress.com/2009/02/23/suppress-warnings-for-xml-comments/

Here i will show you, how you can suppress warnings for XML comments after a Visual Studio build. Background If you have checked the "XML documentation file" mark in the Visual Studio project settings, a XML file containing all XML comments is created. Additionally you will get a lot of warnings also in designer generated files, because of the missing or wrong XML comments. While sometimes warnings helps us to improve and stabilize our code, getting hundreds of XML comment warnings is just a pain. Warnings Missing XML comment for publicly visible type or member … XML comment on … has a param tag for ‘…’, but there is no parameter by that name Parameter ‘…’ has no matching param tag in the XML comment for ‘…’ (but other parameters do) Solution You can suppress every warning in Visual Studio. Right-click the Visual Studio project / Properties / Build Tab Insert the following warning numbers in the "Suppress warnings": 1591,1572,1571,1573,1587,1570

插入一个XML注释。: -)

/// <summary>
/// Describe your member here.
/// </summary>
public string Something
{
    get;
    set;
}

乍一看，这似乎是个笑话，但实际上可能很有用。对我来说，思考方法对于私有方法的作用是有帮助的(当然，除非非常琐碎)。

#pragma warning disable 1591
#pragma warning disable 1591
#pragma warning disable 1572
#pragma warning disable 1571
#pragma warning disable 1573
#pragma warning disable 1587
#pragma warning disable 1570

将警告级别设置为2将抑制此消息。不知道这是否是最好的解决方案，因为它也抑制了有用的警告。

5个选项:

Fill in the documentation comments (great, but time-consuming) Turn off the comment generation (in project properties) Disable the warning in project properties (in 'Project properties' go to Project properties -> Build > "Errors and warnings" (section), Suppress Warnings (textbox), add 1591 (comma separated list)). By default it will change Active Configuration, consider to change configuration to All. Use #pragma warning disable 1591 to disable the warning just for some bits of code (and #pragma warning restore 1591 afterwards) Ignore the warnings (bad idea - you'll miss new "real" warnings)

我想对这里列出的答案补充一些东西:

正如Isak所指出的，XML文档对于类库非常有用，因为它为Visual Studio中的任何消费者提供了智能感知。因此，一个简单而正确的解决方案是关闭任何顶级项目(如UI等)的文档，因为它不会在自己的项目之外实现。

此外，我想指出的是，警告只表示在公开可见的成员。因此，如果将类库设置为只公开它需要公开的内容，则无需记录私有成员和内部成员。