1. ホーム
  2. java

[解決済み] javadocでメソッドパラメータへの参照を追加する方法は?

2022-03-15 09:13:43

質問

メソッドのドキュメント本体から、1つまたは複数のメソッドのパラメータへの参照を追加する方法はありますか? 例えば、以下のようなものです。

/**
 * When {@paramref a} is null, we rely on b for the discombobulation.
 *
 * @param a this is one of the parameters
 * @param b another param
 */
void foo(String a, int b)
{...}

解決方法は?

を読んで分かる限りでは javadocのドキュメント そのような機能はありません。

を使用しないでください。 <code>foo</code> 他の回答で推奨されているように {@code foo} . のような汎用的な型を参照する場合は特に知っておくとよいでしょう。 {@code Iterator<String>} -- は、確かに <code>Iterator&lt;String&gt;</code> ということですね。