Hvordan legge til referanse til en metode parameter i javadoc?

stemmer
261

Er det en måte å legge til referanser til en eller flere av metodens parametre fra metoden dokumentasjon kroppen? Noe som:

/**
 * 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)
{...}
Publisert på 03/11/2009 klokken 13:00
kilden bruker
På andre språk...                            


4 svar

stemmer
9

Jeg antar du kan skrive din egen Doclet eller taglet å støtte denne atferden.

Taglet oversikt

Doclet oversikt

Svarte 03/11/2009 kl. 13:25
kilden bruker

stemmer
57

Som du kan se i Java Source av java.lang.String klasse:

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

Parameter referanser er omgitt av <code></code>koder, noe som betyr at Javadoc syntaks ikke gir noen måte å gjøre noe slikt. (Jeg tror String.class er et godt eksempel på javadoc bruk).

Svarte 03/11/2009 kl. 13:40
kilden bruker

stemmer
306

Så vidt jeg kan fortelle etter å ha lest docs for javadoc er det ingen slik funksjon.

Ikke bruk <code>foo</code>som anbefalt i andre svar; du kan bruke {@code foo}. Dette er spesielt godt å vite når du refererer til en generisk type, for eksempel {@code Iterator<String>}- sikker ser bedre enn <code>Iterator&lt;String&gt;</code>, ikke sant!

Svarte 04/11/2009 kl. 00:50
kilden bruker

stemmer
19

Den riktige måte å referere til en fremgangsmåte parameter er slik:

skriv bildebeskrivelse her

Svarte 13/01/2017 kl. 11:34
kilden bruker

Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more