以下の例に示すように、コメントに 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 がリンクを認識してクリック可能にするので、そうではないと思います。必要に応じて削除しますが、他の人のために参照を残しておきたいと思います。
これが悪い習慣と見なされない場合、警告を抑制せずに (または認識された単語のリストに URL 全体またはその各部分を追加することなく) StyleCop に URL テキストを無視させる方法はありますか? 私は次のことを試しました (URL の行に 4 つのスラッシュ) が、ルール 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>
...
コードをより適切に文書化するのに役立ちます。