如何在javadoc中添加对方法参数的引用？

arguments java javadoc

2022-08-31 04:43:28

有没有办法从方法文档正文中添加对一个或多个方法参数的引用？像这样：

/**
 * 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)
{...}

答案 1

据我所知，在阅读了javadoc的文档之后，没有这样的功能。

不要按照其他答案中的建议使用;您可以使用 .当您引用诸如 -- 肯定看起来比，不是吗？<code>foo</code>{@code foo}{@code Iterator<String>}<code>Iterator<String></code>

答案 2

引用方法参数的正确方法如下所示：