Mixing the use of traditional or block comments (starting with /* and ending with */) and end-of-line comments (from // to the end of the line) can lead to misleading and confusing code, which may result in errors.
Noncompliant Code Example
// */ /* comment, not syntax error */ f = g/**//h; /* equivalent to f = g / h; */ /*//*/ l(); /* equivalent to l(); */ m = n//**/o + p; /* equivalent to m = n + p; */ a = b //*divisor:*/c +d; /* equivalent to a = b+d; */
Compliant Solution
Use a consistent style of commenting:
// Nice simple comment int i; // counter
There are other misuses of comments that should be avoided.
Noncompliant Code Example
Do not use the character sequence /* within a comment:
/* comment with end comment marker unintentionally omitted security_critical_method(); /* some other comment */
In this example, the call to the security-critical method is not executed. A reviewer examining this page could incorrectly assume that the code is executed.
Using an editor that provides syntax highlighting or that formats the code to identify issues like missing end comment delimitors can help detect accidental omissions.
Because missing end delimitors are error prone and often viewed as a mistake, this approach is not recommended for commenting out code.
Compliant Solution
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 change later 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, all the programmer must do is remove the surrounding if statement and the NOTREACHED comment.
The NOTREACHED comment could tell some compilers and static analysis tools not to complain about this unreachable code. It also serves as documentation.
if (false) { /* use of critical security method no
* longer necessary, for now */
/*NOTREACHED*/
security_critical_method();
/* some other comment */
}
This is an instance of exception MSC57-EX2 to MSC57-JG. Detect and remove dead code.
Applicability
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.
Nested block comments and inconsistent use of comments could be detected by suitable static analysis tools.
Related Guidelines
| [Reddy 2000] | Java Coding Style Guide Section 5.0 Comments |
Bibliography