解决StyleCop SA1650捕获URL为拼写错误的单词而没有警告抑制的问题

本文关键字：单词 警告 问题 错误 捕获 SA1650 StyleCop URL 解决 | 更新日期: 2023-09-27 18:16:50

我试图在我的注释中包含一个URL，如下面的例子所示。这会导致StyleCop根据规则SA1650(备注中拼错的单词)报告一个警告，对于我们来说，这个警告不能(通过策略)被抑制。这个警告并不奇怪，因为URL语法不需要正确的英文拼写。

...
/// <remarks>
/// <para>... some remarks ...</para>
/// <para>http://www.foo.wtvr.com</para>
/// <para>... some other remarks ...</para>
/// </remarks>
...

首先，在摘要/注释中包含url被认为是不好的做法吗?我猜不会，因为Visual Studio可以识别链接并使它们可点击。如果有必要，我会删除它，但我想把参考资料留在那里供其他人参考。

如果这个不被认为是坏的做法，有没有一种方法可以让StyleCop忽略URL文本而不抑制警告(或将整个URL或其每个部分添加到可识别的单词列表中)?我尝试了以下操作(URL行上的四个正斜杠)，但这导致了规则SA1644的警告(文档头中不允许空行): 
...
/// <remarks>
/// <para>... some remarks ...</para>
//// <para>http://www.foo.wtvr.com</para>
/// <para>... some other remarks ...</para>
/// </remarks>
...

我目前的解决方案是使用comment-in-comment标记，如下所示，它不会产生任何警告，但我不知道这是否是最佳实践:

...
/// <remarks>
/// <para>... some remarks ...</para>
/// <para><!--http://www.foo.wtvr.com--></para>
/// <para>... some other remarks ...</para>
/// </remarks>
...

解决StyleCop SA1650捕获URL为拼写错误的单词而没有警告抑制的问题

我认为在注释中使用http链接是一个很好的做法。

使用

<see href="http://myurl.com/"/>

相关文章：