java - 如何在javadoc中添加对方法参数的引用?

标签 java arguments 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> 好看,不是吗!

关于java - 如何在javadoc中添加对方法参数的引用?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/1667212/

相关文章:

java - 如何强制 Eclipse Link 创建完全相同的 ClassName 的表?

Java GAE DeferredTask 示例?

c# - 在 C# 中,是否应该检查传递给方法的引用是否为 null?

c#用“异常分割字符串

java - 如何在 Javadocs 中引用 Lombok 生成的方法?

java - PHP 在 sql 查询中使用 $_GET 不返回结果

java - 不允许启动服务 Intent 未经许可不从 uid 导出

javascript - JavaScript 函数作用域如何处理参数?

java - 如何记录多个方法的 javadoc 异常原因

scala - 有没有一种简单的方法可以将 scaladoc 集成到 IntelliJ Idea 中?