1. 序章

コードを記述しているときに、wikiページ、ガイド、ライブラリの公式ドキュメントなど、インターネット上の記事を参照する場合があります。 Javadocにそのような参照記事へのリンクを追加することをお勧めします。

このチュートリアルでは、Javadocで外部URLを参照する方法を学習します。

2. インラインリンクの作成

Javaは外部リンク用の特別なツールを提供していませんが、標準のHTMLを使用できます。インラインリンクを作成するには、次の構文を使用します。

/**
 * Some text <a href="URL#value">label</a> 
 */

ここで、 URL＃valueは相対URLまたは絶対URLにすることができます。

例を考えてみましょう：

/** 
 * Refer to <a href="http://www.baeldung.com">Baeldung</a> 
 */

これは次のようにレンダリングされます：

Baeldungを参照してください

3. 見出し付きのインラインリンクの作成

別の方法は、リンクを含む見出しを作成することです。 @see タグは、これを実現するために次のように使用されます。

/**
 * @see <a href="URL#value">label</a>
 */

次の例を考えてみましょう。

/**
 * @see <a href="http://www.baeldung.com">Baeldung</a> 
 */

これにより、次のリンクを含む「関連項目」の見出しが作成されます。関連項目： Baeldung

4. 別のクラスのJavadocへのリンクを作成する

T @linkタグは、他のクラスおよびメソッドのJavadocにリンクするために特に使用されます。これは、指定されたクラスまたはメソッド参照のドキュメントを指すHTMLハイパーリンクに変換するインラインタグです。

{@リンク }

メソッドdemoを含むクラスDemoOneがあるとします。

/** 
 * Javadoc
 */
class DemoOne {
  
  /**
   * Javadoc
  */
  void demo() {
    //some code
  }
}

これで、次の方法で、上記のクラスのJavadocと別のクラスのメソッドにリンクできます。

/** 
 * See also {@link org.demo.DemoOne}
 */
/**
 * See also {@link org.demo.DemoOne#demo()}
 */

このタグは、コメントを書き込むことができる場所であればどこでも使用できますが、@seeは独自のセクションを作成します。

要約すると、説明でクラス名またはメソッド名を使用する場合は、@linkが推奨されます。 一方、 @see は、関連する参照が説明に記載されていない場合、または同じ参照への複数のリンクの代わりとして使用されます。

5. 結論

この記事では、Javadocで外部リンクを作成する方法について学びました。 また、@seeタグと@linkタグの違いも確認しました。