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

相关推荐
健康平安的活着7 分钟前
java之 junit4单元测试Mockito的使用
java·开发语言·单元测试
Java小白程序员30 分钟前
Spring Framework :IoC 容器的原理与实践
java·后端·spring
hfut02881 小时前
【vscode使用说明】
vscode·编辑器·vim
xuTao6671 小时前
Easy Rules 规则引擎详解
java·easy rules
m0_480502642 小时前
Rust 入门 KV存储HashMap (十七)
java·开发语言·rust
杨DaB2 小时前
【SpringBoot】Swagger 接口工具
java·spring boot·后端·restful·swagger
YA3332 小时前
java基础(九)sql基础及索引
java·开发语言·sql
桦说编程3 小时前
方法一定要有返回值 \ o /
java·后端·函数式编程
小李是个程序3 小时前
登录与登录校验:Web安全核心解析
java·spring·web安全·jwt·cookie
David爱编程3 小时前
Java 创建线程的4种姿势,哪种才是企业级项目的最佳实践?
java·后端