{@link}タグ

{@link}タグは他のJavadocタグの中で文字列を表示する場所の中に参照リンクを表示したい場合に使用します。このタグは今までのタグがブロックタグと呼ばれるのに対してインラインタグと呼ばれるものです。インラインタグは{}で囲んで使用し、コメントの説明文の中や他のブロックタグの中の文字列の箇所に使用します。

{@link package.class#member label}

ブロックタグの中の説明文や文字列の箇所で参照リンクを表示する

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

「package.class#member」の形式で指定した他のメソッドなどへのリンクを作成します。リンクラベルには指定した「label」が表示されますが「label」は省略可能です。省略した場合はリンク先のメソッド名などが表示されます。基本的な使い方は「@see」タグと同じです。

/**
 *  コメントの説明文
 *  次のメソッド{@link Sample05_02#setSize(int, int) setSize}を参照
 */

パッケージ名などを完全指定でない場合にどのようにリンク先を検索するかについては「@seeタグ (参照リンク)」を参照して下さい。

サンプル

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

Sample10.java

/**
 * Javadocテスト用クラス
 */
public class Sample10{
  /**
   * 名前の設定
   * 取得は{@link Sample10#getName() getName}を参照
   * @param name 名前
   */
  public void setName(String name){

  }

  /**
   * 名前の取得
   * 設定は{@link #setName(String)}を参照
   * @return 名前をStringで取得
   */
  public String getName(){

  }
}

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

javadoc -d doc Sample10.java

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

上記のように説明文などの中にインラインでリンクを作成する場合に使用して下さい。リンクを関連項目として別枠で表示したい場合には「@see」タグを使用します。

なお{@link}タグを使用した場合には、リンクで表示される文字列はコードフォントが使用されて表示されます。(コードフォントとはHTMLの<code>...</code>タグで囲んだ場合に適用されるフォントです)。

著者 / TATSUO IKURA

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