Javadoc でメソッドを参照するにはどうすればいいですか? 質問する

Javadoc でメソッドを参照するにはどうすればいいですか? 質問する

@linkタグを使用してメソッドにリンクするにはどうすればよいですか?

変わりたい:

/**
 * Returns the Baz object owned by the Bar object owned by Foo owned by this.
 * A convenience method, equivalent to getFoo().getBar().getBaz()
 * @return baz
 */
public Baz fooBarBaz()

に:

/**
 * Returns the Baz object owned by the Bar object owned by Foo owned by this.
 * A convenience method, equivalent to {@link getFoo()}.{@link getBar()}.{@link getBaz()}
 * @return baz
 */
public Baz fooBarBaz()

しかし、タグを正しくフォーマットする方法がわかりません@link

ベストアンサー1

JavaDocに関する多くの情報は、標準ドックレットのドキュメントコメント仕様、に関する情報を含む

{@link module/package.class#member ラベル}

タグ(探しているもの)です。ドキュメントの対応する例は次のとおりです。

たとえば、getComponentAt(int, int) メソッドを参照するコメントを次に示します。

Use the {@link #getComponentAt(int, int) getComponentAt} method.

module/package.class参照されるメソッドが現在のクラス内にある場合は、その部分を省略できます。


JavaDoc に関するその他の便利なリンクは次のとおりです。

おすすめ記事