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

Question

我有一份关于 class 的文档 header，根据 stylecop，其中的单词拼写不正确。不过，它们是特定于代码的，需要存在。

Error SA1650 : CSharp.Documentation : The documentation text within the summary tag contains incorrectly spelled words: ...

我想抑制错误。我该怎么做？

Answer 1

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

// using System.Diagnostics.CodeAnalysis;

/// <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描述了添加自定义词典的过程——见文末，特别注意build动作。本文还介绍了 XML 的结构以及解决特定警告的方法。

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

How to suppress stylecop error SA1650 (incorrectly spelled words)

c#

documentation

stylecop