如何引用javadoc中的一个方法参数?

问题:

有没有办法从方法文档主体中添加一个或多个方法参数的引用?
就像是:

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

回答:

据我所知,在阅读the docs for javadoc之后,没有这样的功能。
不要在其他答案中推荐使用<code>foo</code>你可以使用{@code foo}。这是特别好的知道什么时候引用通用类型,如{@code Iterator<String>} – 肯定看起来比<code>Iterator&lt;String&gt;</code>更好,不是!

 
 
Code问答: http://codewenda.com/topics/python/
Stackoverflow: How to reference a method parameter in javadoc?

*转载请注明本文链接以及stackoverflow的英文链接

发表评论

电子邮件地址不会被公开。 必填项已用*标注

+ 9 = 10