1. ホーム
  2. java

[解決済み] javadocでメソッドを参照するには?

2022-03-22 01:24:07

質問

を使用するにはどうしたらよいですか? @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 タグが正しく表示されます。

どのように解決するのですか?

JavaDocについては、以下のサイトで多くの情報を得ることができます。 標準Docletのためのドキュメント・コメント仕様 の情報を含む。

{@link module/package.class#member label}のようになります。

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

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

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

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


JavaDocに関する他の有用なリンクは、次のとおりです。