2012-10-01 32 views
11

将注释的拼写检查添加到最新版本的StyleCop。看来我可以重复使用StyleCop的现有CustomDictionary文件(我为FxCop创建的)。 SA1650规则documentation并不是说这是可能的。但在release notes为39年7月4日的版本我看到为StyleCop拼写检查指定CustomDictionary文件的路径

添加在settings.StyleCop 文件中指定的文件夹字典支持。

如何配置StyleCop在我的解决方案的根文件夹中搜索此文件?

回答

0

按照了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的副本放在该特定位置而不是解决方案文件夹的根目录中。

6

添加在解决方案的根目录名为Settings.StyleCop具有以下内容的文件:

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

如果你到包含CustomDictionary.xml文件的文件夹的相对路径替换my-dictionary-folder

6

在我的情况下,它在位于.csproj文件旁的Settings.StyleCop文件中指定了自定义词典条目时起作用。

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

实际上,StyleCopSettingsEditor.exe工具为我创建了这些设置。我使用Visual Studio中的项目的上下文菜单打开它,使用“StyleCop设置”菜单项。