为何我的公共API缺失XML文档时未收到警告？

1. 检查csproj核心配置 #

打开你的.csproj文件，确认以下配置是否正确添加：

• 开启XML文档生成：在<PropertyGroup>节点里加上<GenerateDocumentationFile>true</GenerateDocumentationFile>
• 设置警告级别为4（最高级别，包含文档缺失警告）：<WarningLevel>4</WarningLevel>
• 确保NoWarn里没排除CS1591（这个是“公共成员缺失XML注释”的警告代码），比如<NoWarn></NoWarn>，如果有其他需要保留的警告代码，不要添加CS1591。

示例配置片段：

<PropertyGroup>
  <TargetFramework>netstandard2.0</TargetFramework>
  <UnityProjectType>Package</UnityProjectType>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
  <WarningLevel>4</WarningLevel>
  <NoWarn></NoWarn>
</PropertyGroup>

2. 处理Unity Package特殊配置 #

Unity的Package项目可能自带默认设置，要确认：

• 没有在条件编译的<PropertyGroup>里关闭GenerateDocumentationFile
• 可以手动指定文档输出路径，避免路径问题导致生成失败：<DocumentationFile>bin/Debug/netstandard2.0/YourPackage.xml</DocumentationFile>（路径要和你的目标框架匹配）

3. 确认IDE警告开关 #

• Visual Studio：打开「工具→选项→项目和解决方案→构建并运行」，把「MSBuild项目构建输出详细程度」设为“正常”；再到「工具→选项→文本编辑器→C#→高级」，勾选“生成XML文档文件时显示警告”
• Rider：打开「设置→编辑器→检查→C#→代码样式→注释」，找到“缺少XML注释”项，确保级别设为“警告”并启用

4. 排查特殊成员情况 #

• 显式接口实现的方法默认不会触发CS1591警告，需要注释的话得手动添加
• 泛型类型/方法的注释格式要正确，比如<typeparam name="T">...</typeparam>不能写错，格式错误可能导致警告不触发

5. 验证构建效果 #

不要依赖IDE的增量构建，手动触发「生成解决方案」，查看输出窗口是否出现CS1591警告。如果还是没有，检查csproj里是否有其他构建配置偷偷关闭了文档生成或排除了警告。

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