У меня есть заголовок документации по классу, в котором есть слова, написанные неправильно согласно 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
{
// ...
}
Решением является использование SuppressMessage для подавления предупреждений о словах, относящихся к предметной области. Однако вам необходимо добавить атрибут ко всем методам, содержащим эти слова.
IMHO лучше реализовать собственный словарь, чтобы все экземпляры этих слов игнорировались анализаторами и никогда не генерировали предупреждения.
https://msdn.microsoft.com/en-us/library/bb514188.aspx описывает процесс добавления настраиваемого словаря - см. конец статьи и обратите особое внимание на действие сборки. В статье также описывается структура XML и способы устранения конкретных предупреждений.
The CustomDictionary.xml file should be placed in the same folder as the StyleCop.dll and the Rules. That folder (and all subfolders) are checked for the dictionary files. StyleCop loads CustomDictionary.xml, CustomDictionary.en-GB.xml and then CustomDictionary.en.xml (where en-GB is the culture specified in the Settings.StyleCop file). github.com/DotNetAnalyzers/StyleC blob / master /
- person RinoTom; 03.12.2018
