如何抑制stylecop错误SA1650（拼写错误的单词）

Question

我在一个类上有一个文档标题，根据stylecop，它的单词拼写不正确。它们是特定于代码的，但需要在那里。

  

错误SA1650：CSharp.Documentation：其中的文档文本   摘要标记包含拼写错误的单词：...

我想压制错误。我怎么能这样做？

Answer 1

对我有用的解决方案是使用以下参数添加[SuppressMessage(...)]属性：

/// <summary>
/// ... documentation with misspelled words ...
/// </summary>
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1650:ElementDocumentationMustBeSpelledCorrectly", Justification = "Reviewed.")]
public class Program
{
    // ...
}

Answer 2

使用SuppressMessage来抑制针对特定于域的字词的警告是一种解决方案。但是，您需要将该属性添加到包含这些单词的所有方法中。

实施自定义词典是恕我直言，以便分析人员忽略这些词的所有实例，并且永远不会生成警告。

https://msdn.microsoft.com/en-us/library/bb514188.aspx描述了添加自定义词典的过程 - 请参阅文章的结尾并特别注意构建操作。本文还介绍了XML的结构以及如何解决特定警告。