{@linkplain}タグ

{@linkplain}タグは{@link}タグと基本的な使い方は同じです。他のJavadocタグの中で文字列を表示する場所の中に参照リンクを表示したい場合に使用します。異なる点は{@link}タグを使用した場合にリンクされる文字列はコードテキストで表示されたのに対し、{@linkplain}タグの場合はリンクされる文字列がプレーンテキストで表示される点だけです。

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

{@linkplain package.class#member label}

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

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

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

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

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

サンプル

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

Sample11.java

/**
 * Javadocテスト用クラス<br>
 * メソッドは{@link #setName(String)}を参照<br>
 * メソッドは{@linkplain #setName(String)}を参照
 */
public class Sample11{
  /**
   * 名前の設定
   * @param name 名前
   */
  public void setName(String name){

  }
}

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

javadoc -d doc Sample11.java

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

今回のサンプルでは{@link}タグと{@linkplain}タグの違いだけを見てください。上が{@link}タグで下が{@linkplain}タグを使った場合です。表示形式だけの違いですのでリンクとして表示される文字列に適したタグを選択して下さい。

著者 / TATSUO IKURA

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