如何在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)
{...}

原文由 ripper234 发布,翻译遵循 CC BY-SA 4.0 许可协议

阅读 579
2 个回答

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

不要按照其他答案中的建议使用 <code>foo</code> ;您可以使用 {@code foo} 。当您引用诸如 {@code Iterator<String>} 类的泛型类型时,知道这一点尤其好——当然看起来比 <code>Iterator&lt;String&gt;</code> 更好,不是吗!

原文由 Kevin Bourrillion 发布,翻译遵循 CC BY-SA 3.0 许可协议

引用方法参数的正确方法是这样的:

在此处输入图像描述

原文由 Eurig Jones 发布,翻译遵循 CC BY-SA 3.0 许可协议

撰写回答
你尚未登录,登录后可以
  • 和开发者交流问题的细节
  • 关注并接收问题和回答的更新提醒
  • 参与内容的编辑和改进,让解决方法与时俱进
推荐问题