Eclipse和MyEclipse 手动设置 Java代码 注释模板
一、目的
1. 为什么需要注释规范?
注释规范对于程序员而言尤为重要，有以下几个原因：
一个软件的生命周期中，80%的花费在于维护。
几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护
注释规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码
统一的注释规范可以快速生成文档说明
二、注释说明
Java 程序有两类注释：归档（文本/文档）注释(document comments)和实现注释(implementation comments)。
归档注释：采用java doc（/**...*/）形式进行注释，主要用于通过javadoc 工具转换成HTML 文件。
实现注释：只能使用/*...*/或//形式进行注释，主要用于方法内部的注释。如果需要多行使用/*…… */形式，如果为单行是用//……形式的注释。
1.技巧：选中你要加注释的方法或类，按 Alt + shift + J。
2.设置注释的模板：Window --> Java --> Code Style --> Code Templates --> Comments --> types --> Edit
设置注释模板的入口： Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍：
（一）、归档注释
Eclipse中java文件头注释格式设置
1、 具体操作
(1)在eclipse中，打开Window->Preference->Java->Code Style->Code Template
(2)然后展开Comments节点就是所有需设置注释的元素，参照2注释规范对应设置即可
2、 注释规范
1. 文件（Files）注释
所有的源文件都应该在开头有一个注释，其中列出类名、版本信息、日期和版权声明。
如下：
/**
* 文件名:
* 描述: (用一句话描述该文件做什么)
* 开发人员：
* 创建时间：
*/
/** * @Title: ${file_name} * @Package: ${package_name} * @Description: ${todo}(用一句话描述该文件做什么) * @author:souvc * @date:${date} ${time} * @version:V1.0 */
2. 类（Types）注释（比较重要的）
每一个类都要包含如下格式的注释，以说明当前类的功能等。
方式一：简单的注释，不提供生成的变量。
/**
* 类名:
* 描述: (这里用一句话描述这个类的作用)
* 开发人员：
* 创建时间：
* 发布版本：
*/
方式二：中文注释，提供简单的生成变量。
/** * 类名: ${file_name} * 包名 : ${package_name} * 详细描述: ${todo}(用一句话描述该文件做什么) * 开发人员： souvc * 开发日期：${date} * 发布版本： V1.0 */
方式三：英文注释，提供生成变量。
/** * @ClassName: ${type_name} * @Description: ${todo}(这里用一句话描述这个类的作用) * @author souvc * @date ${date} ${time} * ${tags} */
方式四：增加换行功能。
/** * 类名: ${file_name} <br/> * 包名 : ${package_name} <br/> * 详细描述: ${todo}(用一句话描述该文件做什么) <br/> * 开发人员： souvc <br/> * 开发日期：${date} <br/> * 发布版本： V1.0 <br/> */
方式五：
/** * @ClassName:${type_name} * @Description:${todo}(这里用一句话描述这个类的作用) * @author:souvc * @date: ${date} ${time} * ${tags} */
/** * @ClassName:${type_name} <br/> * @Description:${todo}(这里用一句话描述这个类的作用)<br/> * @author:souvc <br/> * @date: ${date} <br/> * ${tags} <br/> */
3 . 类成员变量和常量(Fields)注释、字段(Fields)注释标签
成员变量和常量需要使用java doc形式的注释，以说明当前变量或常量的含义
文件(Files)注释标签：
/**
* 文件名: ${file_name}
* 描述: (用一句话描述该文件做什么)
* 开发人员： liuhf
* 创建时间： ${date} ${time}
*/
文件(Files)注释标签：
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author souvc
* @date ${date} ${time}
* @version V1.0
*/
/** * @Title: ${file_name} <br/> * @Package ${package_name} <br/> * @Description: ${todo}(用一句话描述该文件做什么) <br/> * @author souvc <br/> * @date ${date} <br/> * @version V1.0 <br/> */
4. 构造方法（Constructor）注释
每一个构造方法都要包含如下格式的注释，以说明此构造方法的功能等。
/**
* 构造方法名:
* 描述: (这里用一句话描述这个方法的作用)
* 开发人员：
* 创建时间：
* 说明参数含义
*/
5. 方法(Methods)注释（比较重要的）
每一个方法都要包括当前方法的用途，当前方法参数的含义，当前方法返回值的内容和抛出异常的列表，如下注释格式：
方式一：
/**
* 方法名：
* 详述：（简单方法可一句话概述）
* 修改记录+版本号：修改者，修改描述（一句话）
* 开发人员：
* 创建时间：
* 说明参数含义
* 说明返回值含义
* 说明发生此异常的条件
*/
方法二：
/** * 方法名：${enclosing_method}</br> * 详述：${todo}（简单方法可一句话概述）</br> * 开发人员：liuhf </br> * 创建时间：${date} </br> * ${tags} * @throws */
...
