Javadoc'taki bir yöntem parametresine başvuru nasıl eklenir?

Yöntem dokümantasyon gövdesinden bir veya daha fazla yöntemin parametresine referans eklemenin bir yolu var mı? Gibi bir şey:

/**
 * 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 için belgeleri okuduktan sonra söyleyebildiğim kadarıyla böyle bir özellik yok.

<code>foo</code>Diğer yanıtlarda önerildiği gibi kullanmayın ; kullanabilirsiniz {@code foo}. Bu, genel bir türden bahsederken bilmek özellikle iyidir {@code Iterator<String>}- emin daha güzel görünüyor <code>Iterator&lt;String&gt;</code>, değil mi!

Java.lang.String sınıfının Java Kaynağında görebileceğiniz gibi:

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

Parametre referansları <code></code>etiketlerle çevrilidir , yani Javadoc sözdizimi böyle bir şey yapmak için herhangi bir yol sağlamaz. (Sanırım String.class javadoc kullanımının iyi bir örneğidir).

Bir yöntem parametresine başvurmanın doğru yolu şöyledir:

Sanırım bu davranışı desteklemek için kendi tabletinizi veya tagletinizi yazabilirsiniz.

Taglet'e Genel Bakış

Dokümana Genel Bakış