Use preferred terms
TypeName |
UsePreferredTerms |
CheckId |
CA1723 |
Category |
Microsoft.Naming |
Breaking Change |
Breaking |
Cause
The name of an externally visible identifier includes a term for which an alternative, preferred term exists.
Rule Description
This rule parses an identifier into tokens. Each single token and each contiguous dual token combination is compared against terms built into the rule and in the Deprecated section of any custom dictionaries. The following table shows the terms built into the rule and their preferred alternatives.
| Obsolete term | Preferred term |
|---|---|
ComPlus |
EnterpriseServices |
Cancelled |
Canceled |
Indices |
Indexes |
LogIn |
LogOn |
LogOut |
LogOff |
SignOn |
SignIn |
SignOff |
SignOut |
Writeable |
Writable |
How to Fix Violations
To fix a violation of this rule, replace the term with the preferred alternative term.
When to Exclude Warnings
Exclude a warning from this rule only if the name of the identifier intentionally and specifically relates to the original term, as opposed to the preferred term.