@returnタグ

広告

「@return」タグは戻り値に関する説明(データ型や範囲など)を表示する場合に使います。 

@return description

戻り値に対する説明を表示する

記述場所 ： メソッド
複数記述 ： 不可
出力形式 ： 戻り値
その他   ：

メソッドの戻り値に対する説明を記述します。使い方としては次のようになります。 

/**
 *  コメントの説明文
 *  @return 計算した面積
 */

サンプル

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

Sample08.java 

/**
 * Javadocテスト用クラス
 */
public class Sample08{
  /**
   * サイズの設定
   * @param width 幅
   * @param height 高さ
   * @return 成功した場合はtrue
   */
  public boolean setSize(int width, int height){

  }
}

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

javadoc -d doc Sample08.java

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

@returnタグ

このタグでは記述した説明文がそのまま表示されるだけです。

( Written by Tatsuo Ikura )

プロフィール画像

著者 / TATSUO IKURA

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