Référence à un paramètre de méthode dans la javadoc

Question

Est-il un moyen de faire référence à l'un des paramètres de la méthode à partir de la documentation de la méthode corps? Quelque chose comme:

/**
 * 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)
{...}

Answer 1

Confirmé que c'est l'une des dizaines de fonctionnalités utiles qui Javadoc manque.

Cependant, ne pas utiliser <code>foo</code> comme recommandé ci-dessus; vous pouvez utiliser {@code foo}. Cela est particulièrement bon à savoir lorsque vous vous référez à un type générique comme {@code Iterator<String>} -- assurez-vous regarde de plus agréable que de <code>Iterator&lt;String&gt;</code>, n'est-ce pas!

Answer 2

Comme vous pouvez le voir dans le Source Java de java.lang.Classe String:

/**
 * 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);
}

Paramètre références sont entourés par <code></code> tags, ce qui signifie que la Javadoc de la syntaxe ne fournit aucun moyen de faire une telle chose. (Je pense String.class est un bon exemple de l'utilisation de javadoc).

Answer 3

Je suppose que vous pourriez écrire votre propre doclet ou taglet à l'appui de ce comportement.

Taglet Aperçu

Doclet Aperçu