Export (0) Print
Expand All

Resource string compound words should be cased correctly

This warning is supported in the stand-alone version of FxCop only. It is not supported in Code Analysis, which is integrated into Visual Studio.

TypeName

ResourceStringCompoundWordsShouldBeCasedCorrectly

CheckId

CA1701

Category

Microsoft.Naming

Breaking Change

NonBreaking

A resource string contains a compound word that does not appear to be cased correctly.

Each word in the resource string is split into tokens based on the casing. Each contiguous two token combination is checked by the Microsoft spelling checker library. If recognized, the word produces a violation of the rule. Examples of compound words that cause a violation are "CheckSum" and "MultiPart", which should be cased as "Checksum" and "Multipart", respectively. Because of previous common usage, several exceptions are built into the rule, and some single words are flagged, such as "Toolbar" and "Filename", that should be cased as two distinct words. In this case, "ToolBar" and "FileName" should be cased as two distinct words.

Naming conventions provide a common look for libraries that target the common language runtime. This reduces the learning curve required for new software libraries, and increases customer confidence that the library was developed by someone with expertise in developing managed code.

Change the word so that it is cased correctly.

It is safe to exclude a warning from this rule if both parts of the compound word are recognized by the spelling dictionary and the intent is to use two words.

Community Additions

ADD
Show:
© 2014 Microsoft