如何让FxCop自定义词典工作？

Question

如何使FxCop自定义词典正常工作？

我尝试在文件'CustomDictionary.xml'中添加要识别的单词,该文件与FxCop项目文件保存在同一文件夹中.这似乎不起作用,因为即使重新加载并重新运行FxCop,我仍然会得到'标识符拼写正确'的FxCop消息.使用版本1.36.

Answer 1

如果你在Visual Studio中使用它...

来自Visual Studio代码分析团队博客

要将自定义词典添加到C#和Visual Basic项目很简单:

1. 在Solution Explorer中,右键单击项目,然后选择Add - > New Item ...
2. 在"模板"下,选择"XML文件",输入字典的名称,例如CodeAnalysisDictionary.xml,然后单击"添加"
3. 在解决方案资源管理器中,右键单击XML文件,然后选择"属性"
4. 在"属性"工具窗口的"构建操作"下,选择"CodeAnalysisDictionary"
5. 在解决方案资源管理器中,双击新创建的字典以将其打开

6. 在XML编辑器中,粘贴以下内容,将"productname"和"companyname"替换为您团队的等价物:

   <Dictionary>
        <Words>
           <Recognized>
               <Word>"productname"</Word>
               <Word>"companyname"</Word>
           </Recognized>
       </Words>
   </Dictionary>
   

您现在可以开始输入自己的自定义单词了.只需为项目中字典中不存在的每个单词添加一个新元素.每个单词都不区分大小写,因此将识别单词的任何大小写.代码分析将在下次运行时自动获取自定义词典.

Answer 2

最简单的方法是将其称为"CustomDictionary.xml"并将其放入您的解决方案文件夹中,其中FxCop(此处测试1.36)将自动将其拾取,如果您有

<CustomDictionaries SearchFxCopDir="True"
                    SearchUserProfile="True"
                    SearchProjectDir="True" />

在您的FxCop项目文件中.

或者,您可以通过/dictionary命令行参数指定它.

Answer 3

据我所知，FxCop 1.35 及更高版本使用两个字典源。

• Microsoft Office 词典（通过 MS Word 等添加单词应该可以）
• “CustomDictionary.xml”文件存储在FxCop 程序文件夹中，而不是项目文件夹中。