Як додати посилання на параметр методу в javadoc?


313

Чи є спосіб додати посилання на один або кілька параметрів методу з органу документації методу? Щось на зразок:

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

Відповіді:


367

Наскільки я можу сказати, прочитавши документи для javadoc , такої функції немає.

Не використовуйте, <code>foo</code>як рекомендовано в інших відповідях; ви можете використовувати {@code foo}. Це особливо добре знати, коли ви посилаєтесь на такий загальний тип, як {@code Iterator<String>}- впевнено, виглядає красивіше <code>Iterator&lt;String&gt;</code>, чи не так!



59

Як ви бачите в джерелі 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).


5
Тег <code> </code> не посилається на певний параметр. Це форматування слова "String" у текст "кодового вигляду".
Naxos84

46

Правильний спосіб посилання на параметр методу такий:

введіть тут опис зображення


2
Це не додає нічого до існуючих відповідей. Видаліть її.
suriv

27
Він не тільки відповідає на питання, але й наочно пояснює, як змінити Javadoc з параметром за допомогою IDE, такого як Intellij. Це стане в нагоді шукачам, які шукають відповідь.
Евриг Джонс

1
На Eclipse це не працює. Але приємна відповідь, тим не менше
Анріке де Суса

2
це слід видалити. уявіть, більше не існує.
user4504267

2
@ user4504267 Принаймні зараз зображення добре виглядає.
ЕрікЕ

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.