¿Cómo agregar una referencia a un parámetro de método en javadoc?
¿Existe alguna manera de agregar referencias a uno o más parámetros de un método desde el cuerpo de la 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)
{...}
Aceptado
Por lo que puedo decir después de leer los documentos de javadoc, no existe tal característica.
No lo utilice <code>foo</code>
como se recomienda en otras respuestas; puedes usar {@code foo}
. Es especialmente bueno saber esto cuando te refieres a un tipo genérico como {@code Iterator<String>}
-- seguro que se ve mejor que <code>Iterator<String></code>
, ¿no es así?
La forma correcta de referirse a un parámetro de método es así: