我正在尝试在我的备注中包含一个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>
...
我目前的解决方案是使用注释中的注释标记,如下所示,它不会产生任何警告,但我不知道这是否是最佳做法：
...
/// <remarks>
/// <para>... some remarks ...</para>
/// <para><!--http://www.foo.wtvr.com--></para>
/// <para>... some other remarks ...</para>
/// </remarks>
...
帮助我更好地记录我的代码.
解决方法:
我相信在评论中使用http链接是一种很好的做法.
使用
<see href="http://myurl.com/"/>
在评论中插入URL时,如here所示.
标签：c,stylecop,remarks 来源： https://codeday.me/bug/20190611/1221462.html
本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享； 2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关； 3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关； 4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除； 5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。