¿Cómo agregar una referencia a un parámetro de método en javadoc?

Question

¿Hay alguna forma de agregar referencias a uno o más de los parámetros de un método desde el cuerpo de la documentación del método? Algo así como:

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

Answer 1

Por lo que puedo decir después de leer the docs for javadoc no hay tal característica.

No utilice <code>foo</code> como se recomienda en otras respuestas; puede usar {@code foo}. Esto es especialmente bueno saber cuando se refiere a un tipo genérico como {@code Iterator<String>} - seguro que se ve mejor que <code>Iterator&lt;String&gt;</code>, ¿no es así?

Answer 2

Creo que se puede escribir su propia doclet o taglet para apoyar este comportamiento.

Taglet Overview

Doclet Overview

Answer 3

Como se puede ver en la Fuente de Java de la clase 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); 
} 

referencias de parámetros están rodeados por <code></code> etiquetas, lo que significa que el La sintaxis de Javadoc no proporciona ninguna forma de hacer tal cosa. (Creo que String.class es un buen ejemplo del uso de javadoc).

Answer 4

La forma correcta de referirse a un parámetro del método es la siguiente: