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

相关推荐
写后端的胖头鱼1 分钟前
如何区分IO/CPU 密集型,线程池核心参数怎么设置
java·线程池·多线程·io密集·cpu密集
JAVA面经实录91724 分钟前
IDEA 开发知识
java·intellij-idea·idea
于樱花森上飞舞28 分钟前
【Redis】哨兵详解
java·开发语言·数据库·redis
weixin_4640780736 分钟前
ppt转为draw.io方法
编辑器
2601_9538246140 分钟前
基于SSM的水果超市管理系统
java·tomcat·maven
guo_wen_qiang43 分钟前
springboot如何自定义一个启动器starter
java·spring boot·intellij-idea
许彰午1 小时前
55-字典缓存与通知SPI
java·低代码·架构
captain3761 小时前
HTTP(2)
java·网络·http·java-ee
徐子童1 小时前
介绍MVCC机制
java·mysql·面试题·秋招·并发·mvcc
Wang's Blog1 小时前
Java 项目实战: 外卖平台-启用禁用员工账号与Long精度丢失修复
java·服务器