CA1704:标识符应正确拼写
CA1704:标识符应正确拼写
类型名 |
IdentifiersShouldBeSpelledCorrectly |
CheckId |
CA1704 |
类别 |
Microsoft.Naming |
是否重大更改 |
是 |
此规则将标识符解析为标记并检查每个标记的拼写。 解析算法执行下列转换:
-
一个新标记以大写字母开头。 例如,MyNameIsJoe 被解析为“My”、“Name”、“Is”和“Joe”标记。
-
对于多个大写字母,最后一个大写字母开始一个新标记。 例如,GUIEditor 被解析为“GUI”和“Editor”标记。
-
移除前导和尾随撇号。 例如,“'sender'”被解析为“sender”标记。
-
下划线表示一个标记的结尾,并被移除。 例如,Hello_world 被解析为“Hello”和“world”标记。
-
嵌入的与号将被移除。 例如,for&mat 被解析为“format”标记。
默认情况下,使用拼写检查器的英语 (en) 版本。 目前没有其他语言字典。
若要修复与此规则的冲突,请更正单词的拼写,或者将单词添加到名为 CustomDictionary.xml 的自定义字典中。 将该字典放在工具的安装目录、项目目录或者用户配置文件下与该工具关联的目录 (%USERPROFILE%\Application Data\...) 中。 若要了解如何在 Visual Studio 中将自定义词典添加到项目,请参阅如何:自定义代码分析字典。
-
将不应造成冲突的单词添加到 Dictionary/Words/Recognized 路径下。
-
将应造成冲突的单词添加到 Dictionary/Words/Unrecognized 路径下。
-
将应标记为已过时的单词添加到 Dictionary/Words/Deprecated 路径下。 有关更多信息,请参见相关的规则主题CA1726:使用首选词条。
-
将首字母缩写词大小写规则的异常添加到 Dictionary/Acronyms/CasingExceptions 路径下。
下面是自定义字典文件的结构示例。
<Dictionary> <Words> <Unrecognized> <Word>cb</Word> </Unrecognized> <Recognized> <Word>stylesheet</Word> <Word>GotDotNet</Word> </Recognized> <Deprecated> <Term PreferredAlternate="EnterpriseServices">ComPlus</Term> </Deprecated> </Words> <Acronyms> <CasingExceptions> <Acronym>CJK</Acronym> <Acronym>Pi</Acronym> </CasingExceptions> </Acronyms> </Dictionary>