Обходной путь для 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 метки, как показано ниже, который не дает никаких предупреждений, но я не знаю, если это лучшая практика:

... 

/// <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.