複数フィールドに対するコメントの記述の注意

広告

Javaでは同じデータ型の複数のフィールドを一度に宣言が可能です。

int width, height;

この形式に対してコメントを記述する場合は次のようになります。

/**
 *  幅と高さを表します
 */
int width, height;

この場合どちらの変数にコメントが対応するかというと両方の変数に対して同じコメントが適用されます。結果として次のように記述した場合と同じです。

/**
 *  幅と高さを表します
 */
int width;

/**
 *  幅と高さを表します
 */
int height;

場合によってはこのような形式でも問題無い場合もありますが、ほとんどの場合は適切なコメントとはなりません。その為、Javadocを利用する場合にはフィールド毎に宣言を行い、別々のコメントを記述するようにして下さい。

サンプル

では簡単な例で試してみます。

Sample03.java

/**
 * Javadocテスト用クラス
 */
public class Sample03{
  /**
   * 幅と高さを保存します
   */
  public int width, height;

  /**
   * サイズの設定
   * @param width 幅
   * @param height 高さ
   */
  public void setSize(int width, int height){

  }
}

では上記のソースコードを「Sample03.java」の名前で保存し、その保存したディレクトリで次のように実行して下さい。

javadoc -d doc Sample03.java

「doc」ディレクトリ内にある「Sample03.html」ファイルをブラウザで見てください。

複数フィールドに対するコメント

複数フィールドに対してコメントを記述した場合は、それぞれのフィールドに同じ説明文が表示されます。

( Written by Tatsuo Ikura )

関連記事 (一部広告含む)