我的项目有超过500 Missing XML Comment
次警告。我知道我可以删除XML注释功能,或者在任何地方粘贴空注释片段,但我更喜欢通用的解决方案,我可以进行一次更改,禁用此类型的所有警告。
我现在做的是放
///<Summary>
///
///</Summary>
或
#pragma warning disable 1591
只是好奇才有可能。
答案 0 :(得分:274)
如上所述,一般来说,我认为不应忽略(压制)这些警告。总而言之,警告的方法是:
Properties
&gt;来取消警告。 Build
&gt; Errors and warnings
&gt; Suppress warnings
输入1591 Properties
中的“XML文档文件”复选框&gt; Build
&gt; Output
#pragma warning disable 1591
,在底部添加#pragma warning restore 1591
答案 1 :(得分:57)
答案 2 :(得分:9)
答案 3 :(得分:4)
这可能是一个评论,但我无法让它符合限制:
我希望仅为Reference.cs和WebService导入禁用它们。实际上我正在使用宏来为文件执行此操作。只需打开文件并执行此宏(在VS2010中测试):
Sub PragmaWarningDisableForOpenFile()
DTE.ActiveDocument.Selection.StartOfDocument()
DTE.ActiveDocument.Selection.NewLine()
DTE.ActiveDocument.Selection.LineUp()
DTE.ActiveDocument.Selection.Insert("#pragma warning disable 1591")
DTE.ActiveDocument.Selection.EndOfDocument()
DTE.ActiveDocument.Selection.NewLine()
DTE.ActiveDocument.Selection.Insert("#pragma warning restore 1591")
DTE.ActiveDocument.Save()
End Sub
真的没办法自动完成吗?每次自动生成的代码覆盖文件时,您都必须重做此项。
答案 4 :(得分:4)
您还可以修改项目的.csproj
文件,使其在第一个<noWarn>1591</noWarn>
内包含一个<PropertyGroup>
标签。
最初来自Alexandru Bucur's Article Here
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
...
<noWarn>1591</noWarn>
</PropertyGroup>
...
</Project>