JetBrains Rider 2025.2 Help

代码检查:无效的 XML 文档注释

与常规注释相比, 以三斜杠开头的 XML 文档注释/// 必须具有特定的结构并使用 支持的 XML 标签

当 XML 文档编写正确时,您可以使用工具自动生成代码库的文档,并在 IDE 中以全面的方式 查看符号文档

此检查有助于识别 XML 文档注释中的许多问题,包括:

  • 未闭合的标签。

  • <see cref=""/> 标签中未知或模糊的引用。

  • 某些行使用双斜杠而非三斜杠

尽管所有这些问题都不会影响代码的功能,但它们仍然值得解决,以提高代码的可维护性和 API 的可用性。

最后修改日期: 2025年 9月 26日