「-version」オプション

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

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

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

javadoc -version 対象ファイル

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

javadoc -version Sample.java

サンプル

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

Sample04_01.java

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

  }
}

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

javadoc -d doc -version Sample04_01.java

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

このように「バージョン」に対して「@version」タグで指定したバージョンが表示されています。

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

javadoc -d doc Sample04_01.java

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

今回は「@version」タグが指定されているにも関わらずバージョンは表示されません。

著者 / TATSUO IKURA

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