que identifique generar documentar documentacion comentarios codigo averigue all java arguments javadoc

identifique - javadoc pdf



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

¿Hay alguna forma de agregar referencias a uno o más de los parámetros de un método desde el cuerpo de documentación del método? Algo 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) {...}


Como puede ver en la fuente 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); }

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


La forma correcta de referirse a un parámetro de método es así:


Por lo que puedo decir, después de leer los documentos de javadoc, no existe tal característica.

No use <code>foo</code> como se recomienda en otras respuestas; puedes usar {@code foo} . Es especialmente bueno saberlo cuando se refiere a un tipo genérico como {@code Iterator<String>} .