Comments

Figure 132. Java™ comment flavors

Multi line comment:

int a;
/*  We define a variable. Then
    subsequently a value is being assigned */
a = 33;

End of line comment:

int a;  // We define a variable.
a = 33; // Then subsequently a value is being assigned

Figure 133. Inline comments

int strength = a /* fixed value */ + b /* age */ + c /* courage */;

being run-time equivalent to:

int strength = a + b + c;

Figure 134. Javadoc™ comments

/**
 * Describing rectangles. ❶
 */
public class Rectangle {

  /**
   * Setting a rectangle's width.
   *
   * @param width The rectangle's new width. ❷
   *          ▲
   *          ┗━━━━━━━━━━━━━━━━━┓
   */                           ▼
  public void setWidth(double width) {
      // Implementation yet missing
  }
  ...
}

❶	A Javadoc™ describing class `Rectangle`.
❷	A Javadoc™ describing a method `setWidth(...)` within class `Rectangle`: `@param width` and `double width are being tightly related`.

Prev	Up	Next
Operator precedence	Home	Statements

Language Fundamentals