@authorタグ

広告

「@author」タグはクラスなどに対して記述し、著者について指定するために使います。

@author name-text

著者について指定

記述場所 : 概要、パッケージ、クラス、インターフェース
複数記述 : 可
出力形式 : 作成者
その他   :「-author」オプションが必要

主にクラスなどのコメントに記述し、著者が誰であるかを指定する場合に使います。同じコメント内で複数回指定することが可能です。

/**
 *  コメントの説明文
 *  @author JavaDrive
 *  @author BuzzWord corp.
 */

複数の「@author」タグが指定された場合、出力される時にそれぞれの著者がカンマ(,)+スペースで区切られて1行にまとめられて出力されます。

注意点としてJavadocの「-author」オプションを指定した場合だけ出力が行われます。(「-author」オプションについては「「-author」オプション」を参照して下さい)。

サンプル

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

Sample01.java

/**
 * Javadocテスト用クラス
 * @author JavaDrive
 * @author BuzzWord corp.
 */
public class Sample01{
  /**
   * サイズの設定
   * @param width 幅
   * @param height 高さ
   */
  public void setSize(int width, int height){

  }
}

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

javadoc -d doc -author Sample01.java

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

@authorタグ

クラスの説明の箇所に「作成者」として「@author」に記述した名前が表示されています。複数の「@author」タグを指定した場合は、まとめて1つの行の中に表示されます。

( Written by Tatsuo Ikura )

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