在 c# 文档注释中允许使用符号并避免分析器警告 CS1570

如何解决在 c# 文档注释中允许使用符号并避免分析器警告 CS1570

我有这个：

/// <summary>
/// Foo
/// </summary>
/// <seealso href="https://www.example.com/foo?q=bar&qux=2"/>

这给出：

XML 注释的 XML 格式不正确 -- 'Reference to undefined entity 'qux'。 csharp(CS1570)

问题是 & 是无效的 XML。

解决方法：

• 将 & 转换为 &
• 使用 #pragma warning disable CS1570 禁用警告
• 来自以下评论：<Nowarn>1570</Nowarn>
• 来自以下评论：查找（使用正则表达式）并将 & 替换为 &

这些都不理想而且浪费时间 - 我只想将我的网址粘贴到代码中并继续。

是否可以将分析器配置为允许使用＆符号？

解决方法

虽然您可以通过将 <NoWarn>1570</NoWarn> 添加到 .csproj 文件来禁用此警告，但这也不是理想的解决方案，因为编译器将忽略具有无效 XML 的文档注释 - 例如注释不会包含在编译器的 XML 输出中，也不会显示在 IDE 的工具提示中。

最好的解决方案是，如果您将大量 URL 粘贴到您的评论中并且不想自己修复它们，则可以对源文件进行查找和替换，以将无效的 &s 修复为 {{ 1}}。这可以作为 pre-build event 完成，以便在每次构建之前运行。