Czy istnieje sposób dodawania odniesień do jednego lub więcej parametrów metody z treści dokumentacji metody? Coś jak:
/**
* 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
Tag jest opisany w Javadoc - Opisy tagów . Zobacz Przykładowe użycie w kodzie JDK8 .Jak widać w Java Source klasy java.lang.String:
Odwołania do parametrów są otoczone
<code></code>
znacznikami, co oznacza, że składnia Javadoc nie zapewnia żadnego sposobu na wykonanie takiej czynności. (Myślę, że String.class jest dobrym przykładem użycia javadoc).źródło
Prawidłowy sposób odwoływania się do parametru metody jest następujący:
źródło
Myślę, że możesz napisać własny doclet lub taglet na poparcie tego zachowania.
Przegląd tagletów
Przegląd Docletu
źródło