Visual Studio禁用缺少XML注释警告

我有一个超过500 Missing XML Comment警告的项目。我知道我可以删除XML注释特性，或者将空注释片段粘贴到任何地方，但是我更喜欢一种通用的解决方案，即只做一个更改就可以禁用所有此类警告。

我刚才做的是放

///<Summary>
///
///</Summary>

或

#pragma warning disable 1591

我只是好奇有没有可能。

122137 次浏览
小开
最佳答案

如上所述，总的来说，我认为这些警告不应该被忽视(压制)。总而言之，绕过警告的方法是:

  • 通过输入1591更改项目Properties > Build > Errors and warnings > Suppress warnings来消除警告
  • 添加XML文档标记(GhostDoc在这方面非常方便)
  • 通过编译器选项抑制警告
  • 取消选中项目Properties > Build > Output中的“XML文档文件”复选框
  • 在各自文件的顶部添加#pragma warning disable 1591，在底部添加#pragma warning restore 1591
小开

这本来是一个评论，但我不能让它符合限制:

我希望只在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

真的没有办法自动做到吗?每次自动生成的代码覆盖该文件时，您都必须重新执行此操作。

小开

进入项目属性，取消选中生成XML文档选项。

Uncheck XML documentation file

重新编译，警告就会消失。

小开

禁用警告: 转到项目属性(右键单击项目并从上下文菜单中选择属性) 转到Build选项卡 enter image description here < / p >

在“禁止警告”文本框中添加1591 enter image description here < / p >

小开
你也可以修改项目的.csproj文件，在第一个<PropertyGroup>中包含一个<noWarn>1591</noWarn>标记。 源自Alexandru Bucur的文章

<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
...
<NoWarn>1591</NoWarn>
</PropertyGroup>
...
</Project>
小开

Visual Studio 2022:

我建议使用Visual Studio中的.editorconfig文件在所有解决方案中设置一个通用的代码风格。

在这种情况下，只需手动将以下代码添加到.editorconfig文件:

# SA0001: XML comment analysis is disabled due to project configuration
dotnet_diagnostic.SA0001.severity = none

对我来说，从编辑器配置设计器中抑制SA0001不起作用。

文件中只能手动设置规则。

小开

若要修复违反此规则的情况，可以通过在项目文件中添加true来启用XML文档文件作为项目输出的一部分。

提到:

https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA0001.md#how-to-fix-violations


提交答案