Eclipse中设置作者日期等Java注释模板

2025-11-20 23:32:19

1、 首先介绍几个常用的注解:

@author 作者名

@date 日期

@version 版本标识

@parameter 参数及其意义

@return 返回值

@throws 异常类及抛出条件

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

@override 重写

这个注解我们在java代码中经常可以看到。

2、设置注释模板的步骤:点击菜单栏上的Window -->Preferences-->Java-->Code Style -->Code Templates,对右侧Comments选项中具体的注释信息进行编辑即可。可勾选上自动添加注释信息,在生成java文件时便会自动生成注释,当然也可以手动插入注释。设置的界面如下:

Eclipse中设置作者日期等Java注释模板

3、点击Edit按钮,进入编辑页面,全部编辑完成后点击“Apply And Close”即可设置完成,并关闭设置页面。

Eclipse中设置作者日期等Java注释模板

Eclipse中设置作者日期等Java注释模板

4、下面介绍具体的Comment如何设置:

1. 点击Comments下的Files可对整个Java文件进行注释:包括公司名称,版权所属,作者信息,日期等。

/**  

* Title: ${file_name}  

* Description:  

* Copyright: Copyright (c) 2017  

* Company: www.baidudu.com  

* @author shenlan  

* @date ${date}  

* @version 1.0  

*/  

5、 点击Types对类进行注释:

/**  

* Title: ${type_name}  

* Description:  

* @author shenlan  

* @date ${date}  

*/  

3. 点击Fields对字段进行注释:

/** ${field}*/  

4. 点击Constructors对构造方法进行注释:

/**  

* Title:  

* Description:  

* ${tags}  

*/  

5. 点击Methods对方法进行注释:

/**  

 * Title: ${enclosing_method}  

 * Description:  

 * ${tags}  

 */  

6、 点击Overriding Methods对重写方法进行注释:

/* (non-Javadoc)  

 * Title: ${enclosing_method}  

 * Description:  

 * ${tags}  

 * ${see_to_overridden}  

 */

7. Delegate methods对代表方法进行注释:

/**  

* ${tags}  

* ${see_to_target}  

*/

8. Getters对get方法进行注释:

/**

 * @return the ${bare_field_name}  

 */

9. Setters对set方法进行注释:

/**

 * @param ${param} the ${bare_field_name} to set  

 */

7、注释模板的导入和导出:点击Import和Export按钮即可。

Eclipse中设置作者日期等Java注释模板

1、在设置模板时如果勾选了自动添加注释信息,则在创建Java文件时会自动生成文档和类的注释信息,若没有勾选,按Shift+Alt+J快捷键也可生成。

Eclipse中设置作者日期等Java注释模板

2、在对类中的方法进行注释是:在方法上方输入/** 后点击回车,即可生成方法注释;或将光标放在方法名上,按住Shift+Alt+J快捷键也可;或在方法上右击,source》Generate Element Comment也可生成注释。

Eclipse中设置作者日期等Java注释模板

声明:本网站引用、摘录或转载内容仅供网站访问者交流或参考,不代表本站立场,如存在版权或非法内容,请联系站长删除,联系邮箱:site.kefu@qq.com。
猜你喜欢