Page History

...

Noncompliant Code Example

Do not use the character sequence /* within a comment:

/* commentComment with end comment marker unintentionally ommittedomitted
...
security_critical_function();
/* someSome other comment */

In this example, the call to the security-critical function is not executed. It is possible that, in reviewing this page, a reviewer may A reviewer examining this page could incorrectly assume that the code is executed.

In cases where this If execution failure is the result of an accidental ommisionomission, it is useful to use an editor that provides syntax highlighting or formats the code to help identify issues like missing end-comment deliminatorsdelimiters.

Because missing end deliminators is delimiters are error prone and often viewed as a mistake, it is recommended that this approach not be used to comment is not recommended for commenting out code.

Compliant

...

Solution (Preprocessor)

Instead of using /* and */ to comment Comment out blocks of code using condition , use conditional compilation (e.g.for example, #if, #ifdef, or #ifdef #ifndef).:

#if 0  /* use
        * Use of critical security function no
        * longer necessary.
        */
security_critical_function();
/* someSome other comment */
#endif

Non-Compliant Example

The text inside a block of code commented out using #if, #ifdef, or #ifndef must still consist of valid preprocessing tokens. This means that the characters " and ' must each be paired just as in real C code, and the pairs must not cross line boundaries. In particular, an apostrophe within a contracted word looks like the beginning of a character constant. Consequently, natural-language comments and pseudocode should always be written between the comment delimiters /* and */ or following //.

Compliant Solution (Compiler)

This compliant solution takes advantage of the compiler's ability to remove unreachable (dead) code. The code inside the if block must remain acceptable to the compiler. If other parts of the program, such as macros, types, or function prototypes, later change in a way that would cause syntax errors, the unexecuted code must be brought up to date to correct the problem. Then, if it is needed again in the future, the programmer need only remove the surrounding if statement and the NOTREACHED comment.

The NOTREACHED comment tells some compilers and static analysis tools not to complain about this unreachable code. It also serves as documentation.

if (0) {  /*
           * Use of critical security function no
           * longer necessary, for now.
           */
  /*NOTREACHED*/
  security_critical_function();
  /* Some other comment */
}

This code is an instance of exception MSC07-C-EX2 to MSC07-C. Detect and remove dead code.

Noncompliant Code Example

Following The following are some additional examples of comment styles that are confusing and should be avoided:

// */ // comment         /* Comment, not syntax error */
...
f = g/**//h;   //* Equivalent equivalentto toff = g / h; */
...
//\
i(); // part          /* Part of a two-line comment */
...
/\
/ j(); // part        /* Part of a two-line comment
... */


/*//*/ l();    //* equivalentEquivalent to l(); */
...
m = n//**/o
+ p; // equivalent tom          /* Equivalent to m = n + p;

Compliant Example 1

Use a consistent style of commenting:

// Nice simple comment

int i; // counter

 */

a = b //*divisor:*/c
+d;            /*
                * Interpreted as a = b/c + d; in c90
                * compiler and a = b + d; in c99 compiler.
                */

Compliant Solution

...

Use a consistent style of commenting:

Code Block
bgColor #ccccff lang c
/* Nice simple comment */ int i; /* counterCounter */

References

...

Risk Assessment

Confusion over which instructions are executed and which are not can lead to serious programming errors and vulnerabilities, including denial of service, abnormal program termination, and data integrity violation. This problem is mitigated by the use of interactive development environments (IDEs) and editors that use fonts, colors, or other mechanisms to differentiate between comments and code. However, the problem can still manifest, for example, when reviewing source code printed on a black-and-white printer.

Automated Detection

...

Related Vulnerabilities

Search for vulnerabilities resulting from the violation of this rule on the CERT website.

Related Guidelines

Bibliography

...

Image Added Image Added Image Added