eclipse 生成函数说明注释

在Eclipse中生成函数说明注释(JavaDoc风格)可以通过以下方法实现:

  1. 快捷键方式:
  • 将光标放在函数上方
  • 输入/**后按回车键
  • Eclipse会自动生成包含参数和返回值的注释模板
  1. 菜单方式:
  • 选中函数
  • 点击菜单栏 Source > Generate Element Comment

快捷键生成注释 ‌:将光标放在方法名上,按下快捷键Alt+Shift+J,Eclipse会自动生成方法注释的框架,例如:

/**

* @param str

* @return

* @throws ParseException

*/

  1. 自定义模板:
    可通过Window > Preferences > Java > Code Style > Code Templates进行自定义

示例生成的注释格式:

/**

* 计算两个数的和

* @param a 第一个加数

* @param b 第二个加数

* @return 两个参数的和

*/

public int add(int a, int b) {

return a + b;

}

如需配置团队统一的注释规范,建议在项目设置中共享code template配置文件。

相关推荐
凤山老林3 小时前
04-Java JDK, JRE和JVM
java·开发语言·jvm
camellias_10 小时前
【无标题】
java·tomcat
咸鱼2.010 小时前
【java入门到放弃】需要背诵
java·开发语言
椰猫子10 小时前
Java:异常(exception)
java·开发语言
win x11 小时前
Redis 使用~如何在Java中连接使用redis
java·数据库·redis
星晨雪海11 小时前
基于 @Resource 的支付 Service 多实现类完整示例
java·开发语言
阿维的博客日记11 小时前
什么是逃逸分析
java·juc
Ricky_Theseus12 小时前
C++右值引用
java·开发语言·c++
Rick199312 小时前
Java内存参数解析
java·开发语言·jvm
我是大猴子12 小时前
Spring代理类为何依赖注入失效?
java·后端·spring