Comment ajouter une référence à un paramètre de méthode dans javadoc?
Existe-t-il un moyen d’ajouter des références à un ou plusieurs paramètres d’une méthode à partir du corps de la documentation sur la méthode? 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)
{...}
Autant que je sache, après avoir lu les docs pour javadoc il n’existe pas de telle fonctionnalité.
N'utilisez pas <code>foo</code> comme recommandé dans d'autres réponses; vous pouvez utiliser {@code foo}. Ceci est particulièrement utile à savoir lorsque vous vous référez à un type générique tel que {@code Iterator<String>} - c'est plus joli que <code>Iterator<String></code>, n'est-ce pas!
Comme vous pouvez le voir dans la source Java de la classe Java.lang.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);
}
Les références de paramètre sont entourées par les balises <code></code>, ce qui signifie que la syntaxe Javadoc ne fournit aucun moyen de procéder. (Je pense que String.class est un bon exemple d’utilisation de javadoc).
La manière correcte de faire référence à un paramètre de méthode est la suivante:
Je suppose que vous pourriez écrire votre propre doclet ou taglet pour prendre en charge ce problème.