Question

我正在使用Ecliplse并将鼠标悬停在方法名称上，例如。整数的的valueOf 的（0）;

Javadoc给了我参数信息：

Parameters:
      i - an int value.

但是，如果我编写自己的方法（和文档评论）：

/**
* @param i an {@code int} value.
*/
public static void bar(int i) {
}

将鼠标放在方法名称上时，我会有以下内容

Parameters:

      i an int value.

那么，为什么出现的“javadocs”（鼠标悬停）会以不同的格式呈现，即使我写的是与java.lang.Integer的源文件中完全相同的注释？

我有点不喜欢使用大胆的param名称的sencond格式，并且想要坚持第一种格式。我可以用任何方式配置Eclipse来实现这一目标吗？请有人帮我揭开神秘面纱......非常感谢

Answer 1

差异源于individual templates (doclets) you can use when generating Javadoc。如果Eclipse从代码中的注释生成Javadoc（即时），它显然使用省略' - '的模板。当Oracle生成official API documentation for the JRE时，它使用了一个生成' - '的模板。

那么，为什么在浏览JRE代码时会在Eclipse中看到' - '，而不是在自己的代码中？您似乎在Eclipse中配置了JRE（Window＆gt; Preferences＆gt; Java＆gt; Installed JREs），以便Javadoc在文件系统中可用，但JRE源不可用。因此，Eclipse将向您展示正式的Oracle版本，而不是从源代码生成它。

为什么我看不到@param名称和描述之间的破折号？

1 个答案: