Existe uma maneira de adicionar referências a um ou mais parâmetros de um método no corpo da documentação do 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
é descrita em Javadoc - Descrições de tags . Consulte Uso de amostra no código JDK8 .Como você pode ver no Java Source da classe java.lang.String:
As referências de parâmetro são cercadas por
<code></code>
tags, o que significa que a sintaxe Javadoc não fornece nenhuma maneira de fazer isso. (Eu acho que String.class é um bom exemplo de uso de javadoc).fonte
A maneira correta de se referir a um parâmetro de método é assim:
fonte
Eu acho que você poderia escrever seu próprio doclet ou taglet para suportar esse comportamento.
Visão geral do taglet
Visão geral do Doclet
fonte