This is a rule for the two-token compound words in resource strings. If your project contains any resource strings (defined in .resx file, or .settings file), the name of the resource string will be checked by the Microsoft spell checker library, if any violation detected in the spelling of the compound words, Code Analysis tool will generate a warning for this role.
Let’s take an example, the two-token “Stylesheet” is a compound word that represents a CSS style sheet definition of HTML content, this word should be spell as “StyleSheet”, oppositely, “Checksum” is an accepted one-token word (though it looks like a two token word, however it is widely used as checksum), so it should not spell as “CheckSum”. The following table shows the correct and incorrect forms of the commonly used compound words.
| Correct | Incorrect |
| Database | DataBase |
| Checksum | CheckSum |
| FileName | Filename |
| TextBox | Textbox |
| PlaceHolder | Placeholder |
| UserName | Username |
| ToolBar | Toolbar |
| Multipart | MultiPart |
| Stopwatch | StopWatch |
| Hashtable | HashTable |
| Counterpart | CounterPart |
| Hypertext | HyperText |
Do not suppress this role until you want to introduce new words to the Microsoft spell checker library.
To customer the code analysis dictionary, follow the steps described below.
1. Create an XML file in your project, give whatever name for this file (in my case, I name it as CodeAnalysisDictionary.xml which makes more sense)
2. Add your custom words into this file by following this sample structure.
<?xml version="1.0" encoding="utf-8" ?>
<Dictionary>
<Words>
<Unrecognized>
<Word>MSFT</Word>
</Unrecognized>
<Recognized>
<Word>Acme</Word>
</Recognized>
<Deprecated>
<Term PreferredAlternate="Microsoft">MSFT</Term>
</Deprecated>
<Compound>
<Term CompoundAlternate="Stopwatch">StopWatch</Term>
</Compound>
<DiscreteExceptions>
<Term></Term>
</DiscreteExceptions>
</Words>
<Acronyms>
<CasingExceptions>
<Acronym></Acronym>
</CasingExceptions>
</Acronyms>
</Dictionary>
In the Compound section, you can add your own compound word and the preferred terms for this compound word, in the example, I add “Stopwatch” for the compound word “StopWatch” as an alternate.
3. Right click on the CodeAnalysisDictionary.xml file and select Properties, in Properties window, change the Build Action from Content to CodeAnalysisDictionary.
The same rule applies to the identifiers which consist of compound words. The CA1702 defines this rule for the identifiers rather than resource strings.
You can also see this MSDN link for CA1701 for more details.
Subscribe