Eclipse设置注释信息

本文详细介绍了如何在Eclipse中设置Java代码注释模板,包括文件、类、字段、构造函数、方法等各类注释的自定义,以及如何导出和导入注释模板进行备份和复用。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

1、在最上面的工具栏里找到Window下的Preferences。如下图:

2、进入Java—Code Style—Code Templates—Comments,修改Comments里面的注释模板。如图:

① Files【文件注释】

/**
 * @Title: ${file_name}
 * @Package: ${package_name}
 * @Description: 描述该文件做什么
 * @author: 作者信息
 * @date: ${date} ${time}
 * @Company: 公司名
 * @version: V1.0
 * @Copyright: 版权
 */

② Types【类的注释】

/**
 * @ClassName: ${type_name}
 * @Description: 描述这个类的作用
 * @author: 作者名
 * @Company: 公司名
 * @date: ${date} ${time}
 * @param: ${tags}
 */

③ Fields【字段注释】

/**
 * @Fields ${field} : ${todo}(这个变量表示什么)
 */

④ Constructors【构造函数注释】

/**
 * @Title: ${file_name}
 * @Description: 描述这个构造函数的作用
 * @param: ${tags}
 */

⑤ Methods【方法注释】

/**
 * @Title: ${enclosing_method}
 * @Description: 描述这个方法的作用
 * @param: ${tags} 参数说明
 * @return: ${return_type} 返回类型
 * @throws
 */

⑥ Overriding methods【覆盖方法注释】

/**
 * @Title: ${enclosing_method}
 * @Description: 重写方法的描述
 * @param: ${tags}
 * ${see_to_overridden}
 */

⑦ Delegate methods【代表方法注释】

/**
 * ${tags}
 * ${see_to_target}
 */

⑧ Getters【getter方法注释】

/**
 * @Title: ${enclosing_method}
 * @Description: 描述这个get方法的作用
 * @return: ${field_type}
 * @return: the ${bare_field_name}
 */

⑨ Setters【setter方法注释】

/**
 * @Title: ${enclosing_method}
 * @Description: 描述这个set方法的作用
 * @param ${param} the ${bare_field_name} to set
 * @return: ${field_type}
 */

3、修改完成后Apply应用再Apply and Close应用并关闭就可以了,还可以把修改的注释模板Export导出进行备份,也可以Import导入备份的注释模板来使用,如图:

常见的注释

@author 作者名

@date 日期

@version 版本标识

@parameter 参数及其意义

@return 返回值

@throws 异常类及抛出条件

@deprecated 引起不推荐使用的警告

@override 重写

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值