在使用eclipse开发android过程中，注释的使用细节

引文

在商业项目的实施过程中，大部分都是协同开发，svn和git等一系列版本控制软件，在代码管理方面提供了很多便利。但是由于是协同开发，在业务方面就会存在很多交集，需要互相提供支持，所以需要将自己产出的代码进行一系列的注释说明。后期由于因为的展开，逻辑逐渐趋于复杂，为了方便追溯，就需要很完整的注释存在。所以，一个具备专业素养的程序员，产出的代码，注释是占了很大比重的。接下来，一起分析一下，在使用eclipse这个IDE开发基于android平台应用的过程中，注释如何添加。

生成方式

![我的截图](https://img-blog.csdn.net/20150511174051373)
勾选红色区域之后，生成方法和文件，注释会自动添加，只需要将个别属性说明进行更改就可以，如果没有进行勾选，那么需要在你生成方法或者文件之后 输入/**然后单击回车（enter），注释方法也会自动添加上去。（如果看不到截图的情况下： Window ->Preference -> Java -> Code Style -> Code Template 的目录下，apply上方，有一个单选框，那里是设置是否自动添加注释的设置位置）

处理方式

不管是如何配置注释信息，在eclipse中，操作的位置都是一样的。位于eclipse的 Window ->Preference -> Java -> Code Style -> Code Template 目录下。

1.配置模版

生成xml格式模版 直接import（导入）到eclipse当中

2.配置属性

在eclipse的设置界面，针对属性，设置注释信息

属性介绍

注释字段说明

@Title

这个注释一般用于 创建文件时候，填装在package位置附近 当前java文件的说明，一般设置的值为${file_name}

@Package

表示当前文件所在的包名，一般设置的值为 ${package_name}

@Description

用于填写当前文件，方法，字段的说明。一般头部加入${todo}这个字段，实际生成之后的呈现方式 就是大写的TODO

@author

作者，这个文件或者方法到底是谁做的，一般在配置的时候是不会动的，因为这个是作为你产出代码的唯一标识

@date

这个标签表示时间，可以自动生成时间，填充到注释当中。需要注意的主要有这么一个地方，就是${date}${time} 这种设置，显示的是年月日时分秒，可以把${time}去掉，这样时间就会根据年月日这样的格式进行输出了

@version

用于表示版本信息，一般都是固定的，主要是要知道这个资源进行的迭代版本信息 初始信息是 version 1.0

@ClassName

顾名思义，这里显示的是当前方法的名字 设置值为${type_name}

@param

这个是方法参数的说明，设置${tags}之后，生成方法的参数会自动填充到此。

@return

返回值的注释信息，一般设置的值为${bare_field_name}

配置属性

设置目录如下：

（Window ->Preference -> Java -> Code Style -> Code Template）

在当前目录，会看到两个目录Comments和Code两个目录。
接下来，点开Comments目录，会看到里面的属性声明（Files,Types，Fields…..）。这些属性声明，就是针对我们创建的文件，方法等固化的配置目录，彼此绑定。

文件(Files)注释标签：

/**   
* @Title: ${file_name} 
* @Package ${package_name} 
* @Description: ${todo}(这里用一句话描述这个类的作用) 
* @author:  (这里将你个人信息添加上，固定)
* @date ${date} ${time} 
* @version V1.0   
*/ 

类型(Types)注释标签（类的注释）：

/** 
* @ClassName: ${type_name} 
* @Description: ${todo}(这里用一句话描述这个类的作用) 
* @author:  (这里将你个人信息添加上，固定)
* @date ${date} ${time} 
*/ 

字段(Fields)注释标签：

/** 
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) 
*/ 

构造函数标签：

/** 
* @Title: ${enclosing_method} 
* @Description: ${todo}(这里用一句话描述这个方法的作用) 
* @param:${tags} 
*  @return: ${return_type} 
* @throws: 
* */ 

方法(Constructor & Methods)标签：

/** 
* @Title: ${enclosing_method} 
* @Description: ${todo}(这里用一句话描述这个方法的作用) 
* @param: ${tags}    设定文件 
* @return: ${return_type}    返回类型 
* @throws: 
*/ 

覆盖方法(Overriding Methods)标签：

/* * 
* @Title: ${enclosing_method} 
* @Description:  ${todo}(这里用一句话描述这个方法的作用) 
* @param: ${tags}    设定文件 
* @return: ${return_type}    返回类型 
* @throws: 
*/ 

代表方法(Delegate Methods)标签：

/** 
* ${tags} 
* ${see_to_target} 
*/ 

GET方法标签：

/** 
* @return ${bare_field_name} 
*/ 

SET方法标签：

/** 
* @param ${param} 要设置的 ${bare_field_name} 
*/ 

配置模版

<?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><template autoinsert="false" context="gettercomment_context" deleted="false" description="Comment for getter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">
/**
 * getter method
 * @return the ${bare_field_name}
 */

</template><template autoinsert="false" context="settercomment_context" deleted="false" description="Comment for setter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">
/**
 * setter method
 * @param ${param} the ${bare_field_name} to set
 */

</template><template autoinsert="false" context="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">
/**
  * @Title ${enclosing_type}. 
  * &lt;p&gt;Title: &lt;/p&gt;
  * &lt;p&gt;Description: &lt;/p&gt;
  * ${tags}
  */

</template><template autoinsert="false" context="filecomment_context" deleted="false" description="Comment for created Java files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**
 * @Title: ${file_name}
 * @Package ${package_name}
 * @Description: ${todo}
 * @author username
 * @date ${date}
 * @version V1.0
 */

</template><template autoinsert="false" context="typecomment_context" deleted="false" description="Comment for created types" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">
/**
  * @ClassName: ${type_name}
  * @Description: ${todo}
  * @author username
  * @date ${date} ${time}
  * ${tags}
  */

</template><template autoinsert="false" context="fieldcomment_context" deleted="false" description="Comment for fields" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">
/**
  * @Fields ${field} : ${todo}（用一句话描述这个变量表示什么）
  */

</template><template autoinsert="false" context="methodcomment_context" deleted="false" description="Comment for non-overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">
/**
  * @Title: ${enclosing_method}
  * @Description: ${todo}
  * @param ${tags}    设定文件
  * @author username
  * @return ${return_type}    返回类型
  * @throws
  */

</template><template autoinsert="false" context="overridecomment_context" deleted="false" description="Comment for overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">
/**
  * &lt;p&gt;Description: &lt;/p&gt;
  * ${tags}
  * ${see_to_overridden}
  */

</template><template autoinsert="false" context="delegatecomment_context" deleted="false" description="Comment for delegate methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">
/**
  * ${tags}
  * ${see_to_target}
  */

</template><template autoinsert="true" context="newtype_context" deleted="false" description="Newly created files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.newtype" name="newtype">
${filecomment}

${package_declaration}

${typecomment}

${type_declaration}</template><template autoinsert="true" context="classbody_context" deleted="false" description="Code in new class type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.classbody" name="classbody">

</template><template autoinsert="true" context="interfacebody_context" deleted="false" description="Code in new interface type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.interfacebody" name="interfacebody">

</template><template autoinsert="true" context="enumbody_context" deleted="false" description="Code in new enum type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.enumbody" name="enumbody">

</template><template autoinsert="true" context="annotationbody_context" deleted="false" description="Code in new annotation type bodies" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.annotationbody" name="annotationbody">

</template><template autoinsert="true" context="catchblock_context" deleted="false" description="Code in new catch blocks" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.catchblock" name="catchblock">// ${todo} Auto-generated catch block

${exception_var}.printStackTrace();</template><template autoinsert="true" context="methodbody_context" deleted="false" description="Code in created method stubs" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodbody" name="methodbody">// ${todo} Auto-generated method stub

${body_statement}</template><template autoinsert="true" context="constructorbody_context" deleted="false" description="Code in created constructor stubs" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorbody" name="constructorbody">${body_statement}

// ${todo} Auto-generated constructor stub</template><template autoinsert="true" context="getterbody_context" deleted="false" description="Code in created getters" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.getterbody" name="getterbody">return ${field};</template><template autoinsert="true" context="setterbody_context" deleted="false" description="Code in created setters" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.setterbody" name="setterbody">${field} = ${param};</template></templates>

使用说明：

将如上数据，复制下来，在本地创建一个xml文件，粘贴进去。然后在eclipse设置模版的界面，点击import按钮，导入成功后，即可实现，注释的批量自定义。并且根据需要，可以针对模版进行相应的调整，每个注释需要显示的属性信息，也可以自行添加上去。

尾

到此，注释大概需要的东西已经阐述清楚，由于第一次写博客，如果存在偏误，请大家多多指出。建议从事软件开发的朋友们，养成良好的编码习惯，产出代码及时添加注释，方便自己维护，方便同事使用，方便项目回溯，希望我的博文，能为大家提供一些帮助。