eclipse工具使用 （代码注释 工具配置）

一、注释

Java 程序有两类注释：实现注释(implementation comments)和文档注释(document comments)。实现注释是使用/*...*/和//界定的注释。文档注释(被称为"doc comments")由/**...*/界定。文档注释可以通过javadoc 工具转换成HTML 文件。

 

1. 类注释

 

每一个类都要包含如下格式的注释，以说明当前类的功能等。

 

/**

 * @Title: 类名

 * @Package 包名

 * @Description: 类描述信息

 * @author 作者

* @date 创建日期

*/

 

2. 方法注释

每一个方法都要包含 如下格式的注释 包括当前方法的用途，当前方法参数的含义，当前方法返回值的内容和抛出异常的列表。

 

/**

 * @author zxr

 * @methods getName

 * @description 描述信息

 * @date 2014-10-11 下午3:50:34

 * @return 参数说明

 */

3. 类成员变量和常量注释

成员变量和常量需要使用java doc形式的注释，以说明当前变量或常量的含义

/**

* XXXX含义

  */

  

4. 其他注释

方法内部的注释 如果需要多行 使用/*…… */形式，如果为单行是用//……形式的注释。不要再方法内部使用 java doc 形式的注释“/**……**/”，简单的区分方法是，java doc形式的注释在 eclipse中为蓝色，普通注释为绿色。

5. XML注释

规约：如果当前layout 或资源需要被多处调用，或为公共使用的layout（若list_item），则需要在xml写明注释。要求注释清晰易懂。

 

 

二、Eclipse配置方法

 

1. 注释模板

在eclipse 的preferences 中，选择 java à code style àcode Template 

1. 添加文件创建日志模板

 

 

2.设置类注释模板

 

 

1. 导入方法

在eclipse 的preferences 中，选择 java à code style àcode Template 中选择 Import，选择附件中的文件。

但是注意修改 类注释 和 文件注释 的作者名称为自己的！

 

2. 格式化模板

在eclipse 的preferences 中，选择 java à code style àformatter 中选择 Import，选择附件中的文件。

3. XML格式化

在eclipse 的preferences 中，选择 xml à xml files à xml editor 中 做如下设置