Use visually distinct identifiers with meaningful names to eliminate errors resulting from misreading the spelling of an identifier during the development and review of code. An identifier can denote an object; a function; a tag or a member of a structure, union, or enumeration; a typedef name; a label name; a macro name; or a macro parameter.
Depending on the fonts used, certain characters appear visually similar or even identical:
Symbol |
Similar Symbols |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
h (lowercase |
|
|
Do not define multiple identifiers that vary only with respect to one or more visually similar characters.
Make the initial portions of long identifiers unique for easier recognition. This also helps prevent errors resulting from non-unique identifiers. (See rule DCL32-C. Guarantee that mutually visible identifiers are unique.)
In addition, the larger the scope of an identifier, the more descriptive its name should be. It may be perfectly appropriate to name a loop control variable i but the same name would likely be confusing if it named a file scope object or a variable local to a function more than a few lines long. See also recommendations DCL01-C. Do not reuse variable names in subscopes and DCL19-C. Use as minimal a scope as possible for all variables and functions.
Noncompliant Code Example (Source Character Set)
DCL02-C implicitly assumes 'Global Scope' which can be confused with 'Scope within the same file'. Though it may not generate any errors, but there may be a possible violation of the rule as in the example below. Note the example below does not violate DCL32-C. Guarantee that mutually visible identifiers are unique
In file foo.h :: int id_O; // (captial letter O) In file bar.h :: int id_0; // (numeric letter zero)
If a file foobar.h includes both foo.h and bar. h and another file foobar.c that includes foobar.h uses both id0 and idO, it is a violation of DCL02-C.
Compliant Solution (Source Character Set)
In a compliant solution, use of visully similar identifiers should be avoided in the same project scope.
In file foo.h :: int id_a; In file bar.h :: int id_b;
Risk Assessment
Failing to use visually distinct identifiers can result in referencing the wrong object or function, causing unintended program behavior.
Recommendation |
Severity |
Likelihood |
Remediation Cost |
Priority |
Level |
|---|---|---|---|---|---|
DCL02-C |
low |
unlikely |
medium |
P2 |
L3 |
Automated Detection
Tool |
Version |
Checker |
Description |
|---|---|---|---|
| Compass/Rose |
|
|
|
Related Vulnerabilities
Search for vulnerabilities resulting from the violation of this rule on the CERT website.
Related Guidelines
CERT C++ Secure Coding Standard: DCL02-CPP. Use visually distinct identifiers
The CERT Oracle Secure Coding Standard for Java: DCL00-J. Use visually distinct identifiers
ISO/IEC 9899:1999 Section 5.2.4.1, "Translation limits"
ISO/IEC TR 24772 "AJN Choice of Filenames and other External Identifiers," "BRS Leveraging human experience," and "NAI Choice of Clear Names"
MISRA Rule 5.6