Workaround for StyleCop SA1650 catching the URL as a word with an error without warning

Question

I am trying to include a URL in my comments, as shown in the example below. This leads to the fact that StyleCop reports a warning based on rule SA1650 (a word with an error in the notes), which for our purposes cannot be suppressed (by policy). This warning is not surprising, because the URL syntax does not require spelling in English.

...

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

...

First, is it considered bad practice to include URLs in resumes / comments? I assume that since Visual Studio recognizes links and makes them interactive. I will remove it if necessary, but I would like to leave a link there for others.

, StyleCop URL ( URL- )? ( URL), 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/"/> 

URL- .