.NET项目保留GenerateDocumentationFile并将CS1591错误降级为警告的方法

一、保留GenerateDocumentationFile同时避免CS1591错误 #

可以通过以下几种方式实现：

• 补全XML注释：为所有公共可见的类型、方法、属性等添加标准XML注释（如/// <summary>...</summary>），从根源解决注释缺失问题，这也是符合开发规范的最佳实践。
• 局部抑制检查：针对不需要注释的特定文件、类型或成员，通过特性或项目配置排除CS1591检查：
  • 代码特性标记：在目标类型/成员上方添加[SuppressMessage("Microsoft.Design", "CS1591", Justification = "无需注释")]
  • 项目文件针对特定文件配置：

    <ItemGroup>
      <Compile Update="无需注释的文件.cs">
        <NoWarn>CS1591</NoWarn>
      </Compile>
    </ItemGroup>
    

二、将CS1591从错误降级为警告 #

如果当前CS1591被设为错误，可通过以下两种方式降级为警告：

• 项目文件配置：在.csproj的<PropertyGroup>节点中添加或修改配置，确保CS1591不被列为“将警告视为错误”的范围：

  <PropertyGroup>
    <!-- 移除CS1591的错误标记，恢复为警告 -->
    <WarningsAsErrors>$(WarningsAsErrors);!CS1591</WarningsAsErrors>
  </PropertyGroup>
  

  注：如果项目原本仅单独将CS1591设为错误，直接删除对应的<WarningsAsErrors>CS1591</WarningsAsErrors>配置即可。
• Visual Studio图形界面设置：右键项目→属性→生成→错误和警告→选择“将警告视为错误”为“特定警告”，在下方输入框中删除CS1591（或添加!CS1591排除），保存后生效。

内容的提问来源于stack exchange，提问作者serge