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

Question

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

谢谢.

Answer 1

命令是" Add Javadoc Comment"或" Generate Element Comment"(Alt+ Shift+ J),它取决于当前选择的一个元素.

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

但是从项目资源管理器中,正如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 {
    ...
}