@sinceタグ

広告

「@since」タグは導入されたバージョンを表示する場合に使います。「@version」タグは現在のバージョンを表すのに対して、「@since」タグはどのバージョンから導入されて(そして現在のバージョンでも使用できる)いるかを表す点が異なります。

@since since-text

導入されたバージョンを表示する

記述場所 : 概要、パッケージ、クラス、インターフェース、フィールド、メソッド
複数記述 : 可
出力形式 : 導入されたバージョン
その他   :

バージョンなどを表す文字列を指定します。使い方としては次のようになります。

/**
 *  コメントの説明文
 *  @since 2.5.1
 */

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

サンプル

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

Sample06.java

/**
 * Javadocテスト用クラス
 * @since 2.5.1
 * @since Project 1.4A
 */
public class Sample06{
  /**
   * サイズの設定
   * @param width 幅
   * @param height 高さ
   * @since 1.8
   */
  public void setSize(int width, int height){

  }
}

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

javadoc -d doc Sample06.java

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

@sinceタグ

@sinceタグ

複数の「@since」タグを指定した場合は、まとめて1つの行の中に表示されます。

( Written by Tatsuo Ikura )

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