c# - StyleCop SA1650 在没有警告抑制的情况下将 URL 捕获为拼写错误的单词的解决方法

Question

我正在尝试在我的评论中包含一个 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>

...

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

Answer 1

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

使用

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

当在您的评论中插入 URL 作为回答 here .