Укажите путь к файлу CustomDictionary для проверки орфографии StyleCop

В последних версиях StyleCop добавлена ​​проверка орфографии в комментариях. Кажется, я могу повторно использовать свой существующий файл CustomDictionary (который я создал для FxCop) со StyleCop. В документации правила SA1650 не говорится, что это возможно. Но в примечаниях к выпуску для версии 4.7.39 я вижу

Добавить поддержку указания папок словарей в файле settings.StyleCop.

Как мне настроить StyleCop для поиска этого файла в корневой папке моего решения?


person Andrew Bezzub    schedule 01.10.2012    source источник


Ответы (4)


В моем случае это сработало, когда я указал пользовательские словарные записи в файле Settings.StyleCop, расположенном рядом с файлом .csproj.

<GlobalSettings>
  <StringProperty Name="MergeSettingsFiles">NoMerge</StringProperty>
  <CollectionProperty Name="RecognizedWords">
    <Value>word1</Value>
    <Value>word2</Value>
    ...
  </CollectionProperty>
</GlobalSettings>

Собственно, эти настройки мне создавала утилита StyleCopSettingsEditor.exe. Я открыл его, используя контекстное меню проекта в Visual Studio, используя пункт меню «Настройки StyleCop».

person Marek Dzikiewicz    schedule 26.06.2013

Добавьте в корневой каталог решения файл с именем Settings.StyleCop со следующим содержимым:

<StyleCopSettings Version="105">
  <GlobalSettings>
    <CollectionProperty Name="DictionaryFolders">
      <Value>**my-dictionary-folder**</Value>
    </CollectionProperty>
  </GlobalSettings>
</StyleCopSettings>

Если вы замените my-dictionary-folder относительным путем к папке, содержащей ваш файл CustomDictionary.xml.

person Boinst    schedule 31.05.2013

Согласно документации StyleCop для правила SA1650

Файл CustomDictionary.xml следует поместить в ту же папку, что и StyleCop.dll и Правила. Эта папка (и все подпапки) проверяются на наличие файлов словарей. StyleCop загружает CustomDictionary.xml, CustomDictionary.en-GB.xml, а затем CustomDictionary.en.xml (где en-GB - культура, указанная в файле Settings.StyleCop). StyleCop также загружает custom.dic, custom.en-GB.dic, а затем custom.en.dic (где en-GB - культура, указанная в файле Settings.StyleCop). Распознанные слова также можно добавить в файл Settings.StyleCop с помощью редактора настроек на вкладке проверки орфографии.

Таким образом, похоже, что вам нужно будет поместить копию CustomDictionary.xml в это конкретное место, а не в корень папки решения.

person Paul Hunt    schedule 30.10.2012

Аналогичный вопрос был задан здесь http://stylecop.codeplex.com/workitem/7422 и здесь есть открытый билет, http://stylecop.codeplex.com/workitem/7435, который я Вера предоставит вам то, что вы ищете, если это будет сделано.

person Mightymuke    schedule 07.11.2012