Есть ли способ добавить ссылки на один или несколько параметров метода из тела документации метода? Что-то вроде:
/**
* 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<String></code>, не так ли!
@code описан в Javadoc - описания тегов. См. Пример использования в коде JDK8.
- person pba; 06.09.2019
Как вы можете видеть в исходном коде Java класса 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);
}
Ссылки на параметры окружены тегами <code></code>, что означает, что синтаксис Javadoc не предоставляет никакого способа сделать это. (Я думаю, что String.class - хороший пример использования javadoc).
Правильный способ обращения к параметру метода выглядит следующим образом:
Я думаю, вы могли бы написать свой собственный доклет или теглет для поддержки такого поведения.
На 2021 год лучше всего использовать @param:
/**
* When {@param 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: https://idratherbewriting.com/java-javadoc-tags/ < / а>
