web-dev-qa-db-ja.com

javadocでメソッドパラメータへの参照を追加するにはどうすればよいですか？

メソッドのドキュメント本体からメソッドのパラメーターの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)
{...}
javaargumentsjavadoc
285
ripper234

javadocのドキュメント を読んだ後にわかる限り、そのような機能はありません。

他の回答で推奨されているように<code>foo</code>を使用しないでください。 {@code foo}を使用できます。これは、{@code Iterator<String>}などのジェネリック型を参照するときに特に役立ちます。<code>Iterator&lt;String&gt;</code>よりも見た目が良いのは確かです。

339
Kevin Bourrillion

Java.lang.StringクラスのJava Sourceでわかるように：

/**
 * Allocates a new <code>String</code> that contains characters from
 * a subarray of the character array argument. The <code>offset</code>
 * argument is the index of the first character of the subarray and
 * the <code>count</code> argument specifies the length of the
 * subarray. The contents of the subarray are copied; subsequent
 * modification of the character array does not affect the newly
 * created string.
 *
 * @param      value    array that is the source of characters.
 * @param      offset   the initial offset.
 * @param      count    the length.
 * @exception  IndexOutOfBoundsException  if the <code>offset</code>
 *               and <code>count</code> arguments index characters outside
 *               the bounds of the <code>value</code> array.
 */
public String(char value[], int offset, int count) {
    if (offset < 0) {
        throw new StringIndexOutOfBoundsException(offset);
    }
    if (count < 0) {
        throw new StringIndexOutOfBoundsException(count);
    }
    // Note: offset or count might be near -1>>>1.
    if (offset > value.length - count) {
        throw new StringIndexOutOfBoundsException(offset + count);
    }

    this.value = new char[count];
    this.count = count;
    System.arraycopy(value, offset, this.value, 0, count);
}

パラメーター参照は<code></code>タグで囲まれています。つまり、Javadoc構文ではそのようなことを行う方法は提供されていません。 （String.classはjavadocの使用法の良い例だと思います）。

60
Lastnico

メソッドパラメータを参照する正しい方法は次のとおりです。

enter image description here

31
Eurig Jones

この動作をサポートするために、独自のドックレットまたはタグレットを作成できると思います。

タグレットの概要

ドックレットの概要

10
jitter