¿Hay alguna manera 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)
{...}
@code
etiqueta se describe en Javadoc - Descripciones de etiquetas . Consulte Uso de muestra en código JDK8 .Como puede ver en la fuente Java de la clase java.lang.String:
Las referencias de parámetros están rodeadas de
<code></code>
etiquetas, lo que significa que la sintaxis de Javadoc no proporciona ninguna forma de hacer tal cosa. (Creo que String.class es un buen ejemplo del uso de javadoc).fuente
La forma correcta de referirse a un parámetro de método es así:
fuente
Supongo que podrías escribir tu propio doclet o taglet para apoyar este comportamiento.
Descripción general del taglet
Resumen de Doclet
fuente