为 Eclipse 中的现有代码生成 JavaDoc 注释

Question

我知道在创建类、接口等时可以在向导屏幕中生成它们的注释，但我还没有找到为现有文件生成 javadoc 注释的选项。是否可以？

谢谢。

Answer 1

命令是“添加 Javadoc 注释”或“生成元素注释”（Alt+Shift+J），并且它取决于当前选择的one元素。

它不能应用于所有文件。因此，如果您通过项目资源管理器视图选择所有类，您将无法从那里生成所有缺少的注释。

但从 Project Explorer 来看，正如 Vitalii Fedorenko 在评论中提到的那样，它有效（刚刚测试过）：

您应该在 Package Explorer 中展开一个类，选择所有元素并按 Alt+Shift+J

Answer 2

如果您喜欢双手放在键盘上，那么在方法之前的行中键入 /** 并按 Enter 也可以：

/**[press enter here]
int avg(int a, int b) throws ArithmeticException {
    ...
}

-->

/**
 * 
 * @param a
 * @param b
 * @return
 * @throws ArithmeticException
 */
int avg(int a, int b) throws ArithmeticException {
    ...
}

Answer 3

这个 https://stackoverflow.com/a/8223484/830945 为这个问题提供了一个很好的解决方案。

我自己已经测试过，它与 eclipse 配合得很好。
您只需右键单击项目，然后选择所需的选项。可以从 http://jautodoc.sourceforge.net/index.html 下载