在Eclipse中生成函数说明注释(JavaDoc风格)可以通过以下方法实现:
- 快捷键方式:
- 将光标放在函数上方
- 输入
/**
后按回车键 - Eclipse会自动生成包含参数和返回值的注释模板
- 菜单方式:
- 选中函数
- 点击菜单栏 Source > Generate Element Comment
快捷键生成注释:将光标放在方法名上,按下快捷键Alt+Shift+J
,Eclipse会自动生成方法注释的框架,例如:
/**
* @param str
* @return
* @throws ParseException
*/
- 自定义模板:
可通过Window > Preferences > Java > Code Style > Code Templates进行自定义
示例生成的注释格式:
/**
* 计算两个数的和
* @param a 第一个加数
* @param b 第二个加数
* @return 两个参数的和
*/
public int add(int a, int b) {
return a + b;
}
如需配置团队统一的注释规范,建议在项目设置中共享code template配置文件。