@paramタグ

「@param」タグはパラメータに関する説明を表示する場合に使います。

@param parameter-name description

パラメータに対する説明を表示する

記述場所 ： メソッド
複数記述 ： 可
出力形式 ： 導入されたバージョン
その他   ：

メソッドのパラメータ名と、そのパラメータに対する説明を記述します。使い方としては次のようになります。

/**
 *  コメントの説明文
 *  @param width 幅
 *  @param height 高さ
 */

説明の部分は複数行にまたがって記述することが可能です。複数行に渡っていることを示すような特別な記述は必要ありません。

/**
 *  コメントの説明文
 *  @param width 幅
 *    widthに関する説明2行目
 *    widthに関する説明3行目
 *  @param height 高さ
 */

サンプル

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

Sample07.java

/**
 * Javadocテスト用クラス
 */
public class Sample07{
  /**
   * サイズの設定
   * @param width 幅<br>
   *    (単位はセンチメートル)
   * @param height 高さ
   */
  public void setSize(int width, int height){

  }
}

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

javadoc -d doc Sample07.java

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

@paramタグ

複数行に渡って説明を記述した場合もHTML文書として扱われる事に注意して下さい(改行する場合は<br>などの改行用のタグが必要です)。

( Written by Tatsuo Ikura )

著者 / TATSUO IKURA

これから IT 関連の知識を学ばれる方を対象に、色々な言語でのプログラミング方法や関連する技術、開発環境構築などに関する解説サイトを運営しています。