Visual Studio禁用缺少XML注释警告

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

我刚才做的是放

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

#pragma warning disable 1591

我只是好奇有没有可能。

当前回答

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

提到:

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

其他回答

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

提到:

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

禁用警告: 转到项目属性(右键单击项目并从上下文菜单中选择属性) 转到Build选项卡

在“抑制警告”文本框中添加1591

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

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

您还可以修改项目的.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不起作用。

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

推荐文章