StyleCop SA1650的解决方法将URL作为拼写错误的单词捕获而没有警告抑制

Question

我试图在我的评论中包含一个网址，如下例所示。这会导致StyleCop根据规则SA1650（备注中拼写错误的单词）报告警告，这对于我们的目的不能被抑制（通过策略）。这个警告并不奇怪，因为URL语法不要求正确的英文拼写。

...

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

...

首先，在摘要/备注中包含网址是否被视为不良做法？我猜不会，因为Visual Studio识别链接并使它们可以点击。如有必要，我会将其删除，但我希望将参考资料留给其他人使用。

如果不是被视为不良做法，有没有办法让StyleCop忽略网址文字而不用来抑制警告（或添加整个网址或它的每一部分都被认可的单词列表）？我已经尝试了以下（URL＆＃39;行上的四个正斜杠），但结果是来自规则SA1644的警告（文档标题中不允许空行）：

...

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

...

我目前的解决方案是使用评论中的评论标签，如下所示，这不会产生任何警告，但我不知道这是否是最佳做法：

...

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

...

帮助我更好地记录我的代码。

Answer 1

我相信在评论中使用http链接是一种很好的做法。

使用

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

在评论中按照已解答的http://im.ezgif.com/tmp/ezgif-3302899694.gif插入网址。