Есть ли способ добавить ссылки на один или несколько параметров метода из тела документации метода? Что-то вроде:
/**
* 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
тег описан в Javadoc - описание тегов . См. Пример использования в коде JDK8 .Как вы можете видеть в Java Source класса java.lang.String:
Ссылки на параметры
<code></code>
заключены в теги, что означает, что синтаксис Javadoc не предоставляет никакого способа сделать это. (Я думаю, что String.class является хорошим примером использования javadoc).источник
Правильный способ ссылки на параметр метода выглядит следующим образом:
источник
Я думаю, вы могли бы написать свой собственный доклет или тэглет для поддержки этого поведения.
Обзор Taglet
Доклет Обзор
источник