Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

Noncompliant Code Example (Initialization)

This noncompliant code example might lead a programmer or reviewer to mistakenly believe that both i and j are initialized to 1. In fact, only j is initialized; i remains uninitialized.

Code Block
bgColor#FFcccc
int i, j = 1;

...

Compliant Solution (Initialization)

In this compliant solution, it is readily apparent that both i and j are initialized to 1.

Code Block
bgColor#ccccff
int i = 1;  // purpose of i...
int j = 1;  // purpose of j...

...

Compliant Solution (Initialization)

In this compliant solution, it is readily apparent that both i and j are initialized to 1.

...

Declaring each variable on a separate line is the prefered method. However, multiple variables on one line are acceptable when they are small temporary variables such as array indexes.

...

Noncompliant Code Example (Different Types)

In this noncompliant code example, the programmer declares multiple variables, including an array, on the same line. All instances of the type T have access to methods of the Object class. However, it is easy to forget that arrays require special treatment when some of these methods are overridden.

...

Code Block
// Correct functional implementation
public String toString(){
  String s = a.toString() + b.toString();
  for(int i = 0; i < c.length; i++){
    s += c[i].toString();
  }
  s += d.toString();
  return s;
}

...

Compliant Solution (Different Types)

This compliant solution places each declaration on its own line and uses the preferred notation for array declaration.

Code Block
bgColor#ccccFF
public class Example {
  private T a;   // purpose of a...
  private T b;   // purpose of b...
  private T[] c; // purpose of c[]...
  private T d;   // purpose of d...

  public Example(T in){
    a = in;
    b = in;
    c = (T[]) new Object[10];
    d = in;
  }
}

...

Exceptions

DCL01-EX1: Note that the declaration of a loop counter in a for statement is in violation of this guideline because the declaration is not on its own line with an explanatory comment about the variable's role. However, declaration of loop indices in for statements is not only a common idiom; it also provides the benefit of restricting the scope of the loop index to the for loop itself. This is a specific reason to relax this guideline.

...

Code Block
bgColor#ccccff
for (int i = 0; i < mx; ++i ) {
  /* ... */
}

...

Risk Assessment

Declaration of multiple variables per line can reduce code readability and lead to programmer confusion.

Guideline

Severity

Likelihood

Remediation Cost

Priority

Level

DCL01-J

low

unlikely

low

P3

L3

...

Related Guidelines

C Secure Coding Standard: DCL04-C. Do not declare more than one variable per declaration

C++ Secure Coding Standard: DCL04-CPP. Do not declare more than one variable per declaration

...

Bibliography

Wiki Markup
\[[Conventions 2009|AA. Bibliography#Conventions 09]\] Section 6.1, "Number Per Line"
\[[ESA 2005|AA. Bibliography#ESA 05]\] Rule 9: Put single variable definitions in separate lines.
\[[JLS 2005|AA. Bibliography#JLS 05]\] [§ 8.3, "Field Declarations"|http://java.sun.com/docs/books/jls/third_edition/html/classes.html#8.3], [§ 9.3, "Field (Constant) Declarations"|http://java.sun.com/docs/books/jls/third_edition/html/classes.html#9.3][§ 14.4, "Local Variable Declaration Statements"|http://java.sun.com/docs/books/jls/third_edition/html/statements.html#14.4] § 6.1, "Declarations", §4.3.2, "The class Object"

...