eclipse注释模板设置
Eclipse作为JavaIDE（Integrated Development Environment,集成开发环境）,可以通过设置自动添加Javadoc注释信息，如@author 作者名、@version 版本标识、@date 日期等，在创建类或新增方法时会自动添加注释信息。关于java如何生成javadoc文档可参考下文。下面将会为大家介绍如何在Eclipse中设置Java注释模板。
- Eclipse Oxygen Release (4.7.0)
方法/步骤
-
首先介绍几个常用的注解：
@author 作者名
@date 日期
@version 版本标识
@parameter 参数及其意义
@return 返回值
@throws 异常类及抛出条件
@deprecated 引起不推荐使用的警告
@override 重写
这个注解我们在java代码中经常可以看到。
-
设置注释模板的步骤：点击菜单栏上的Window -->Preferences-->Java-->Code Style -->Code Templates，对右侧Comments选项中具体的注释信息进行编辑即可。可勾选上自动添加注释信息，在生成java文件时便会自动生成注释，当然也可以手动插入注释。设置的界面如下：
-
点击Edit按钮，进入编辑页面，全部编辑完成后点击“Apply And Close”即可设置完成，并关闭设置页面。
-
下面介绍具体的Comment如何设置：
1. 点击Comments下的Files可对整个Java文件进行注释：包括公司名称，版权所属，作者信息，日期等。
/**
* <p>Title: ${file_name}</p>
* <p>Description: </p>
* <p>Copyright: Copyright (c) 2017</p>
* <p>Company: www.baidudu.com</p>
* @author shenlan
* @date ${date}
* @version 1.0
*/
-
2. 点击Types对类进行注释：
/**
* <p>Title: ${type_name}</p>
* <p>Description: </p>
* @author shenlan
* @date ${date}
*/
3. 点击Fields对字段进行注释：
/** ${field}*/
4. 点击Constructors对构造方法进行注释：
/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/
5. 点击Methods对方法进行注释：
/**
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
*/
-
6. 点击Overriding Methods对重写方法进行注释：
/* (non-Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${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
*/
-
注释模板的导入和导出：点击Import和Export按钮即可。
END