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配置文件。

相关推荐
南极星10051 天前
我的创作纪念日--128天
java·python·opencv·职场和发展
郝学胜-神的一滴1 天前
超越Spring的Summer(一): PackageScanner 类实现原理详解
java·服务器·开发语言·后端·spring·软件构建
摇滚侠1 天前
Java,举例说明,函数式接口,函数式接口实现类,通过匿名内部类实现函数式接口,通过 Lambda 表达式实现函数式接口,演变的过程
java·开发语言·python
打工的小王1 天前
java并发编程(七)ReentrantReadWriteLock
java·开发语言
lang201509281 天前
Java并发革命:JSR-133深度解析
java·开发语言
abluckyboy1 天前
基于 Java Socket 实现多人聊天室系统(附完整源码)
java·开发语言
Re.不晚1 天前
JAVA进阶之路——数据结构之线性表(顺序表、链表)
java·数据结构·链表
毅炼1 天前
Java 基础常见问题总结(3)
java·开发语言
亓才孓1 天前
[JDBC]事务
java·开发语言·数据库
CHU7290351 天前
直播商城APP前端功能全景解析:打造沉浸式互动购物新体验
java·前端·小程序