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

转载自：https://jingyan.baidu.com/article/1612d500856cb1e20e1eeed5.html

Eclipse作为JavaIDE（Integrated Development Environment,集成开发环境）,可以通过设置自动添加Javadoc注释信息，如@author 作者名、@version 版本标识、@date 日期等，在创建类或新增方法时会自动添加注释信息。关于java如何生成javadoc文档可参考下文。下面将会为大家介绍如何在Eclipse中设置Java注释模板。

4Eclipse规范注释及注释文档的生成

工具/原料

Eclipse Oxygen Release (4.7.0)

方法/步骤

1

首先介绍几个常用的注解：

@author 作者名

@date 日期

@version 版本标识

@parameter 参数及其意义

@return 返回值

@throws 异常类及抛出条件

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

@override 重写

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

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

点击Edit按钮，进入编辑页面，全部编辑完成后点击“Apply And Close”即可设置完成，并关闭设置页面。
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

2. 点击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

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按钮即可。

END

Java注释模板的使用

1

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

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

END

注意事项

注释模板设置完一定要点击Appy保存

Eclipse中设置作者日期等Java注释模板相关推荐

Eclipse Java注释模板设置
Eclipse Java注释模板设置详解设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开 ...
eclipse java 模板下载_Eclipse Java注释模板
这是Eclipse Java注释模板下载,Eclipse Java 注释模板,设置后可以使用快捷键快速生成文档注释,版本信息等. 软件介绍 Eclipse Java注释模板是在一个项目的完整的生命周期 ...
java注释模板_Java注释模板设置
Java注释模板设置 eclipse中设置Java注释模板 eclipse设置注释模板的入口: Window->Preference->Java->Code Style->Co ...
eclipse maven打包jar 部分jsp无法访问_Maven系列教材（九）- 在Eclipse中创建maven风格的java web项目...
Maven系列教材 (九)- 在Eclipse中创建maven风格的java web项目步骤1:删除j2ee目录步骤2:新建Maven 项目步骤3:这个界面点下一步步骤4: 这个界面使用webapp ...
android指定日期闹钟,如何在android中设置特定日期的闹钟？
嗨我需要使用时间选择器来设置特定日期的闹钟.当我给出静态输入时,闹钟设置不正确并响铃. 例如:我给静态输入(与日期,月份和年份),但它不振铃.这是我的代码.如何在android中设置特定日期的闹钟? ...
在eclipse中设置server.xml与context.xml分离
在eclipse中设置<context>与<server>分离打开server面板,如下图打开后双击所要编辑的服务器,即可打开tomcat编辑器(tomcat server ...
Eclipse Java注释模板设置详解，更改 ${user}和${date}
修改MyEclipse eclipse 注释的作者名字转自:http://www.oschina.net/question/158170_31311 在eclipse/myeclipse中,当我们去 ...
Eclipse Java注释模板设置详解
设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元 ...
[转]Eclipse Java注释模板设置详解
原文链接:http://blog.csdn.net/ahhsxy/archive/2009/09/11/4542682.aspx 设置注释模板的入口: Window->Preference-&g ...