@seeタグ (テキスト、外部リンク)

広告

「@see」タグは「関連項目」として外部リンク又はテキストを表示したり、他のフィールドやメソッドなどへの参照リンクを表す場合に使います。ここではテキスト及び外部リンクとしての利用方法を見ていきます(参照リンクは次のページを参照して下さい)。

@see reference

関連項目としてテキストやリンクを表示

記述場所 : 概要、パッケージ、クラス、インターフェース、フィールド、メソッド
複数記述 : 可
出力形式 : 関連項目
その他   :

まず関連項目の箇所に情報として文字列を表示する場合です。

@see "string"

表示したい文字列をダブルクオーテーション("")で囲って指定します。使い方としては次のようになります。

/**
 *  コメントの説明文
 *  @see "C/C++"
 */

次に外部サイトへのリンクを表示する場合です。

@see <a href="URL">label</a>

HTML文における<a>タグと同じ書式でリンク先及びリンクラベルを指定します。使い方としては次のようになります。

/**
 *  コメントの説明文
 *  @see <a href="http://jp.sun.com/">サン・マイクロシステムズ</a>
 */

複数の「@see」タグが指定された場合、グループ化されてまとめて出力されます。

サンプル

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

Sample03.java

/**
 * Javadocテスト用クラス
 * @see "C/C++"
 * @see <a href="http://jp.sun.com/">サン・マイクロシステムズ</a>
 */
public class Sample03{
  /**
   * サイズの設定
   * @param width 幅
   * @param height 高さ
   * @see <a href="http://www.yahoo.co.jp/">ヤフー</a>
   */
  public void setSize(int width, int height){

  }
}

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

javadoc -d doc Sample03.java

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

@seeタグ

@seeタグ

クラス及びメソッドに対して「@see」タグを使って関連情報を表示させています。複数の「@see」タグを指定した場合は、まとめて1つの行の中に表示されます。

( Written by Tatsuo Ikura )

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