228

我有一个包含 500 多个Missing XML Comment警告的项目。我知道我可以删除 XML 注释功能，或者将空的注释片段粘贴到任何地方，但我更喜欢通用解决方案，我可以在其中进行一项更改以禁用所有此类警告。

我刚才所做的就是把

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

或者

#pragma warning disable 1591

只是好奇这是否可能。

4

6 回答 6

356

如上所述，总的来说，我认为不应忽略（抑制）这些警告。总而言之，绕过警告的方法是：

  • 通过更改项目来抑制警告Properties> Build> Errors and warnings>Suppress warnings输入 1591
  • 添加 XML 文档标签（GhostDoc可以非常方便）
  • 通过编译器选项抑制警告
  • 取消选中项目中的“XML 文档文件”复选框Properties>>BuildOutput
  • #pragma warning disable 1591在相应文件的顶部和#pragma warning restore 1591底部添加
于 2011-12-16T09:28:11.797 回答
91

禁用警告：转到项目属性（右键单击您的项目并从上下文菜单中选择属性）转到构建选项卡 在此处输入图像描述

将 1591 添加到抑制警告文本框 在此处输入图像描述

于 2016-12-28T07:44:09.523 回答
59

您还可以修改项目.csproj文件以<noWarn>1591</noWarn>在第一个<PropertyGroup>. 最初来自Alexandru Bucur 的文章

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    ...
    <NoWarn>1591</NoWarn>
  </PropertyGroup>
  ...
</Project>
于 2019-01-25T19:52:09.440 回答
15

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

取消选中 XML 文档文件

重新编译，警告应该消失。

于 2015-09-23T19:06:23.360 回答
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

真的没有办法自动做到这一点吗？每次自动生成的代码覆盖文件时，您都必须重做。

于 2012-05-08T12:38:54.093 回答
1

视觉工作室 2022：

我建议.editorconfig在 Visual Studio 中使用文件来为所有解决方案设置通用代码样式。

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

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

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

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

于 2022-01-27T12:46:22.963 回答