「-author」オプション

「-author」オプションは生成されたドキュメントに「@author」タグで指定された著者を出力するように指定します。「-author」オプションが指定されていない場合は「@author」タグがコメント中に記述されていても生成されるドキュメントに著者は出力されません。

※「@author」タグについては「@authorタグ」を参照して下さい。

使い方は次のようになります。

javadoc -author 対象ファイル

例えば次のよう実行します。

javadoc -author Sample.java

サンプル

では実際に試してみます。

Sample03_01.java

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

  }
}

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

javadoc -d doc -author Sample03_01.java

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

このように「作成者」に対して「@author」タグで指定した著者が表示されています。

では同じソースファイルに対して「-author」オプションを指定せずに次のように実行して下さい。

javadoc -d doc Sample03_01.java

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

今回は「@author」タグが指定されているにも関わらず著者は表示されません。

著者 / TATSUO IKURA

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