Jak dodać odwołanie do parametru metody w javadoc?

313

Czy istnieje sposób dodawania odniesień do jednego lub więcej parametrów metody z treści dokumentacji metody? Coś jak:

/**
 * 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)
{...}
ripper234
źródło

Odpowiedzi:

367

O ile mogę stwierdzić po przeczytaniu dokumentacji dla javadoc, nie ma takiej funkcji.

Nie używaj <code>foo</code>zgodnie z zaleceniami w innych odpowiedziach; możesz użyć {@code foo}. Jest to szczególnie dobrze wiedzieć, gdy mówisz o typie ogólnym, takim jak {@code Iterator<String>}- na pewno wygląda ładniej niż <code>Iterator&lt;String&gt;</code>, prawda!

Kevin Bourrillion
źródło
@codeTag jest opisany w Javadoc - Opisy tagów . Zobacz Przykładowe użycie w kodzie JDK8 .
pba
59

Jak widać w Java Source klasy 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);
}

Odwołania do parametrów są otoczone <code></code>znacznikami, co oznacza, że ​​składnia Javadoc nie zapewnia żadnego sposobu na wykonanie takiej czynności. (Myślę, że String.class jest dobrym przykładem użycia javadoc).

Lastnico
źródło
5
Tag <code> </code> nie odwołuje się do określonego parametru. Formatuje słowo „String” w tekst „wyglądający na kod”.
Naxos84
46

Prawidłowy sposób odwoływania się do parametru metody jest następujący:

wprowadź opis zdjęcia tutaj

Eurig Jones
źródło
2
Nie dodaje to niczego do istniejących odpowiedzi. Proszę to usunąć.
suriv
27
Nie tylko odpowiada na pytanie, ale wizualnie wyjaśnia, jak zmienić Javadoc za pomocą parametru przy użyciu IDE, takiego jak Intellij. Przyda się to poszukiwaczom, którzy szukają odpowiedzi.
Eurig Jones,
1
W Eclipse nie działa. Niemniej jednak jest to miła odpowiedź
Henrique de Sousa
2
należy to usunąć. wyobraź sobie, że już nie istnieje.
user4504267
2
@ user4504267 Zdjęcie wygląda dobrze, przynajmniej teraz.
ErikE