クラスには、stylecopに従って正しく綴られない単語を持つドキュメントヘッダーがあります。彼らはコード固有であり、そこにいる必要があります。スタイルキャップのエラーを抑制する方法SA1650(間違って綴られた単語)
エラーSA1650:CSharp.Documentation:ドキュメントのテキスト 内の要約タグが誤って綴られた単語が含まれます...
が、私はエラーを抑制したいです。これどうやってするの?
クラスには、stylecopに従って正しく綴られない単語を持つドキュメントヘッダーがあります。彼らはコード固有であり、そこにいる必要があります。スタイルキャップのエラーを抑制する方法SA1650(間違って綴られた単語)
エラーSA1650:CSharp.Documentation:ドキュメントのテキスト 内の要約タグが誤って綴られた単語が含まれます...
が、私はエラーを抑制したいです。これどうやってするの?
私は、ドメイン固有のソリューションである言葉で警告を抑制するためにSuppressMessage
を使用して、必要なカテゴリとcheckId
/// <summary>
/// ... documentation with misspelled words ...
/// </summary>
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1650:ElementDocumentationMustBeSpelledCorrectly", Justification = "Reviewed.")]
public class Program
{
// ...
}
を見つけました。ただし、それらの単語を含むすべてのメソッドに属性を追加する必要があります。
これらの単語のすべてのインスタンスがアナライザーによって無視され、警告が生成されないように、カスタム辞書を実装する方がよいでしょう。
https://msdn.microsoft.com/en-us/library/bb514188.aspxは、カスタム辞書を追加するプロセスを説明しています。記事の最後を参照し、ビルドアクションに特に注意してください。また、XMLの構造と特定の警告の解決方法についても説明します。
この回答を試みたことがありますかhttps://stackoverflow.com/questions/3287656/how-to-suppress-a-stylecop-warning? –
これは別のスタイル・コープ・エラーです。この特定のメッセージを抑制する方法を知りたいです。 –
自分で答えの値を代入する必要があります。最初のパラメータはCSharp.DocumentationやMicrosoftのStyleCop.CSharp.Documentationのようなものだと思います。 2番目はSA1650です:ElementDocumentationMustBeSpelledCorrectly –