C# 如何抑制stylecop错误SA1650(拼写错误的单词)

C# 如何抑制stylecop错误SA1650(拼写错误的单词),c#,documentation,stylecop,C#,Documentation,Stylecop,我在一个类上有一个文档头,它包含根据stylecop拼写不正确的单词。但是,它们是特定于代码的,需要存在 错误SA1650:CSharp。文档:中的文档文本 摘要标记包含拼写错误的单词: 我想隐瞒这个错误。如何才能做到这一点?我的解决方案是使用以下参数添加[SuppressMessage(…)]属性: // using System.Diagnostics.CodeAnalysis; /// <summary> /// ... documentation with misspell

我在一个类上有一个文档头,它包含根据stylecop拼写不正确的单词。但是,它们是特定于代码的,需要存在

错误SA1650:CSharp。文档:中的文档文本 摘要标记包含拼写错误的单词:


我想隐瞒这个错误。如何才能做到这一点?

我的解决方案是使用以下参数添加
[SuppressMessage(…)]
属性:

// using System.Diagnostics.CodeAnalysis;

/// <summary>
/// ... documentation with misspelled words ...
/// </summary>
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1650:ElementDocumentationMustBeSpelledCorrectly", Justification = "Reviewed.")]
public class Program
{
    // ...
}
//使用System.Diagnostics.CodeAnalysis;
/// 
/// ... 拼写错误的文档。。。
/// 
[SuppressMessage(“StyleCop.CSharp.DocumentationRules”,“SA1650:ElementDocumentations必须正确拼写”,justionment=“Review”)]
公共课程
{
// ...
}

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

最好实现一个自定义词典,以便分析器忽略这些单词的所有实例,并且永远不会生成警告


描述添加自定义词典的过程-请参阅本文末尾,并特别注意构建操作。本文还介绍了XML的结构以及如何解决特定警告。

您尝试过这个答案吗?这是一个不同的stylecop错误,我想知道如何抑制这个特定消息您必须用自己的值替换答案中的值。我认为第一个参数应该类似于CSharp.Documentation或Microsoft,StyleCop.CSharp.Documentation。第二个是SA1650:ElementDocumentation必须正确拼写刚刚找到的值,已经作为答案放在您的答案指向FxCop文档。但是,这里的问题是一个问题。StyleCop文档中的以下注释有助于:
CustomDictionary.xml文件应与StyleCop.dll和规则放在同一文件夹中。将检查该文件夹(以及所有子文件夹)中的字典文件。StyleCop加载CustomDictionary.xml、CustomDictionary.en-GB.xml,然后加载CustomDictionary.en.xml(其中en-GB是Settings.StyleCop文件中指定的区域性)。
@RinoTom移动手指写入;而且,有了命令,继续前进。。。或者正如法国人所说的“事情改变得越多,就越保持不变”