允许在 c# 文档注释中使用 & 符号并避免分析器警告 CS1570
Allow ampsersands in c# doccomments and avoid analyzer warning CS1570
我有这个：
/// <summary>
/// Foo
/// </summary>
/// <seealso href="https://www.example.com/foo?q=bar&qux=2"/>
这给出：
XML comment has badly formed XML -- 'Reference to undefined entity 'qux'.' csharp(CS1570)
问题是 & 无效 XML。
解决方法：
- 将
& 转换为 &
- 使用
#pragma warning disable CS1570 禁用警告
- 来自以下评论：
<NoWarn>1570</NoWarn>
- 来自以下评论：查找（使用正则表达式）并将
& 替换为 &
这些都不理想而且浪费时间 - 我只想将我的 URL 粘贴到代码中并继续。
是否可以将分析器配置为允许 & 符号？
虽然您 可以 通过将 <NoWarn>1570</NoWarn> 添加到您的 .csproj 文件来禁用此警告，但这也不是一个理想的解决方案，因为编译器将忽略以下文档注释无效 XML - 此类注释不会包含在编译器的 XML 输出中，也不会显示在 IDE 的工具提示中。
如果您将大量网址粘贴到您的评论中并且不想自己修复它们，那么最好的解决方案是对您的源文件进行查找和替换，以将无效的 & 修复为&。这可以作为 pre-build event 完成，以便它在每次构建之前运行。
我有这个：
/// <summary>
/// Foo
/// </summary>
/// <seealso href="https://www.example.com/foo?q=bar&qux=2"/>
这给出：
XML comment has badly formed XML -- 'Reference to undefined entity 'qux'.' csharp(CS1570)
问题是 & 无效 XML。
解决方法：
- 将
&转换为& - 使用
#pragma warning disable CS1570 禁用警告
- 来自以下评论：
<NoWarn>1570</NoWarn> - 来自以下评论：查找（使用正则表达式）并将
&替换为&
这些都不理想而且浪费时间 - 我只想将我的 URL 粘贴到代码中并继续。
是否可以将分析器配置为允许 & 符号？
虽然您 可以 通过将 <NoWarn>1570</NoWarn> 添加到您的 .csproj 文件来禁用此警告，但这也不是一个理想的解决方案，因为编译器将忽略以下文档注释无效 XML - 此类注释不会包含在编译器的 XML 输出中，也不会显示在 IDE 的工具提示中。
如果您将大量网址粘贴到您的评论中并且不想自己修复它们，那么最好的解决方案是对您的源文件进行查找和替换，以将无效的 & 修复为&。这可以作为 pre-build event 完成，以便它在每次构建之前运行。