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

引文

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

生成方式

![我的截图](http://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)注释标签：

<code class="hljs java has-numbering" style="display: block; padding: 0px; color: inherit; box-sizing: border-box; font-family: 'Source Code Pro', monospace;font-size:undefined; white-space: pre; border-top-left-radius: 0px; border-top-right-radius: 0px; border-bottom-right-radius: 0px; border-bottom-left-radius: 0px; word-wrap: normal; background: transparent;"><span class="hljs-javadoc" style="color: rgb(136, 0, 0); box-sizing: border-box;">/**   *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @Title</span>: ${file_name} *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @Package</span> ${package_name} *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @Description</span>: ${todo}(这里用一句话描述这个类的作用) *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @author</span>:  (这里将你个人信息添加上，固定)*<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @date</span> ${date} ${time} *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @version</span> V1.0   */</span> </code><ul class="pre-numbering" style="box-sizing: border-box; position: absolute; width: 50px; top: 0px; left: 0px; margin: 0px; padding: 6px 0px 40px; border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); list-style: none; text-align: right; background-color: rgb(238, 238, 238);"><li style="box-sizing: border-box; padding: 0px 5px;">1</li><li style="box-sizing: border-box; padding: 0px 5px;">2</li><li style="box-sizing: border-box; padding: 0px 5px;">3</li><li style="box-sizing: border-box; padding: 0px 5px;">4</li><li style="box-sizing: border-box; padding: 0px 5px;">5</li><li style="box-sizing: border-box; padding: 0px 5px;">6</li><li style="box-sizing: border-box; padding: 0px 5px;">7</li><li style="box-sizing: border-box; padding: 0px 5px;">8</li></ul>

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

<code class="hljs java has-numbering" style="display: block; padding: 0px; color: inherit; box-sizing: border-box; font-family: 'Source Code Pro', monospace;font-size:undefined; white-space: pre; border-top-left-radius: 0px; border-top-right-radius: 0px; border-bottom-right-radius: 0px; border-bottom-left-radius: 0px; word-wrap: normal; background: transparent;"><span class="hljs-javadoc" style="color: rgb(136, 0, 0); box-sizing: border-box;">/** *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @ClassName</span>: ${type_name} *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @Description</span>: ${todo}(这里用一句话描述这个类的作用) *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @author</span>:  (这里将你个人信息添加上，固定)*<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @date</span> ${date} ${time} */</span> </code><ul class="pre-numbering" style="box-sizing: border-box; position: absolute; width: 50px; top: 0px; left: 0px; margin: 0px; padding: 6px 0px 40px; border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); list-style: none; text-align: right; background-color: rgb(238, 238, 238);"><li style="box-sizing: border-box; padding: 0px 5px;">1</li><li style="box-sizing: border-box; padding: 0px 5px;">2</li><li style="box-sizing: border-box; padding: 0px 5px;">3</li><li style="box-sizing: border-box; padding: 0px 5px;">4</li><li style="box-sizing: border-box; padding: 0px 5px;">5</li><li style="box-sizing: border-box; padding: 0px 5px;">6</li></ul>

字段(Fields)注释标签：

<code class="hljs java has-numbering" style="display: block; padding: 0px; color: inherit; box-sizing: border-box; font-family: 'Source Code Pro', monospace;font-size:undefined; white-space: pre; border-top-left-radius: 0px; border-top-right-radius: 0px; border-bottom-right-radius: 0px; border-bottom-left-radius: 0px; word-wrap: normal; background: transparent;"><span class="hljs-javadoc" style="color: rgb(136, 0, 0); box-sizing: border-box;">/** *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @Fields</span> ${field} : ${todo}(用一句话描述这个变量表示什么) */</span> </code><ul class="pre-numbering" style="box-sizing: border-box; position: absolute; width: 50px; top: 0px; left: 0px; margin: 0px; padding: 6px 0px 40px; border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); list-style: none; text-align: right; background-color: rgb(238, 238, 238);"><li style="box-sizing: border-box; padding: 0px 5px;">1</li><li style="box-sizing: border-box; padding: 0px 5px;">2</li><li style="box-sizing: border-box; padding: 0px 5px;">3</li></ul>

构造函数标签：

<code class="hljs java has-numbering" style="display: block; padding: 0px; color: inherit; box-sizing: border-box; font-family: 'Source Code Pro', monospace;font-size:undefined; white-space: pre; border-top-left-radius: 0px; border-top-right-radius: 0px; border-bottom-right-radius: 0px; border-bottom-left-radius: 0px; word-wrap: normal; background: transparent;"><span class="hljs-javadoc" style="color: rgb(136, 0, 0); box-sizing: border-box;">/** *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @Title</span>: ${enclosing_method} *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @Description</span>: ${todo}(这里用一句话描述这个方法的作用) *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @param</span>:${tags} * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @return</span>: ${return_type} *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @throws</span>: * */</span> </code><ul class="pre-numbering" style="box-sizing: border-box; position: absolute; width: 50px; top: 0px; left: 0px; margin: 0px; padding: 6px 0px 40px; border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); list-style: none; text-align: right; background-color: rgb(238, 238, 238);"><li style="box-sizing: border-box; padding: 0px 5px;">1</li><li style="box-sizing: border-box; padding: 0px 5px;">2</li><li style="box-sizing: border-box; padding: 0px 5px;">3</li><li style="box-sizing: border-box; padding: 0px 5px;">4</li><li style="box-sizing: border-box; padding: 0px 5px;">5</li><li style="box-sizing: border-box; padding: 0px 5px;">6</li><li style="box-sizing: border-box; padding: 0px 5px;">7</li></ul>

方法(Constructor & Methods)标签：

<code class="hljs java has-numbering" style="display: block; padding: 0px; color: inherit; box-sizing: border-box; font-family: 'Source Code Pro', monospace;font-size:undefined; white-space: pre; border-top-left-radius: 0px; border-top-right-radius: 0px; border-bottom-right-radius: 0px; border-bottom-left-radius: 0px; word-wrap: normal; background: transparent;"><span class="hljs-javadoc" style="color: rgb(136, 0, 0); box-sizing: border-box;">/** *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @Title</span>: ${enclosing_method} *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @Description</span>: ${todo}(这里用一句话描述这个方法的作用) *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @param</span>: ${tags}    设定文件 *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @return</span>: ${return_type}    返回类型 *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @throws</span>: */</span> </code><ul class="pre-numbering" style="box-sizing: border-box; position: absolute; width: 50px; top: 0px; left: 0px; margin: 0px; padding: 6px 0px 40px; border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); list-style: none; text-align: right; background-color: rgb(238, 238, 238);"><li style="box-sizing: border-box; padding: 0px 5px;">1</li><li style="box-sizing: border-box; padding: 0px 5px;">2</li><li style="box-sizing: border-box; padding: 0px 5px;">3</li><li style="box-sizing: border-box; padding: 0px 5px;">4</li><li style="box-sizing: border-box; padding: 0px 5px;">5</li><li style="box-sizing: border-box; padding: 0px 5px;">6</li><li style="box-sizing: border-box; padding: 0px 5px;">7</li></ul>

覆盖方法(Overriding Methods)标签：

<code class="hljs ruby has-numbering" style="display: block; padding: 0px; color: inherit; box-sizing: border-box; font-family: 'Source Code Pro', monospace;font-size:undefined; white-space: pre; border-top-left-radius: 0px; border-top-right-radius: 0px; border-bottom-right-radius: 0px; border-bottom-left-radius: 0px; word-wrap: normal; background: transparent;">/* * * <span class="hljs-variable" style="color: rgb(102, 0, 102); box-sizing: border-box;">@Title</span><span class="hljs-symbol" style="color: rgb(0, 102, 102); box-sizing: border-box;">:</span> <span class="hljs-variable" style="color: rgb(102, 0, 102); box-sizing: border-box;">${</span>enclosing_method} * <span class="hljs-variable" style="color: rgb(102, 0, 102); box-sizing: border-box;">@Description</span><span class="hljs-symbol" style="color: rgb(0, 102, 102); box-sizing: border-box;">:</span>  <span class="hljs-variable" style="color: rgb(102, 0, 102); box-sizing: border-box;">${</span>todo}(这里用一句话描述这个方法的作用) * <span class="hljs-variable" style="color: rgb(102, 0, 102); box-sizing: border-box;">@param</span><span class="hljs-symbol" style="color: rgb(0, 102, 102); box-sizing: border-box;">:</span> <span class="hljs-variable" style="color: rgb(102, 0, 102); box-sizing: border-box;">${</span>tags}    设定文件 * <span class="hljs-variable" style="color: rgb(102, 0, 102); box-sizing: border-box;">@return</span><span class="hljs-symbol" style="color: rgb(0, 102, 102); box-sizing: border-box;">:</span> <span class="hljs-variable" style="color: rgb(102, 0, 102); box-sizing: border-box;">${</span>return_type}    返回类型 * <span class="hljs-variable" style="color: rgb(102, 0, 102); box-sizing: border-box;">@throws</span><span class="hljs-symbol" style="color: rgb(0, 102, 102); box-sizing: border-box;">:</span> *<span class="hljs-regexp" style="color: rgb(0, 136, 0); box-sizing: border-box;">/ </span></code><ul class="pre-numbering" style="box-sizing: border-box; position: absolute; width: 50px; top: 0px; left: 0px; margin: 0px; padding: 6px 0px 40px; border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); list-style: none; text-align: right; background-color: rgb(238, 238, 238);"><li style="box-sizing: border-box; padding: 0px 5px;">1</li><li style="box-sizing: border-box; padding: 0px 5px;">2</li><li style="box-sizing: border-box; padding: 0px 5px;">3</li><li style="box-sizing: border-box; padding: 0px 5px;">4</li><li style="box-sizing: border-box; padding: 0px 5px;">5</li><li style="box-sizing: border-box; padding: 0px 5px;">6</li><li style="box-sizing: border-box; padding: 0px 5px;">7</li></ul>

代表方法(Delegate Methods)标签：

<code class="hljs java has-numbering" style="display: block; padding: 0px; color: inherit; box-sizing: border-box; font-family: 'Source Code Pro', monospace;font-size:undefined; white-space: pre; border-top-left-radius: 0px; border-top-right-radius: 0px; border-bottom-right-radius: 0px; border-bottom-left-radius: 0px; word-wrap: normal; background: transparent;"><span class="hljs-javadoc" style="color: rgb(136, 0, 0); box-sizing: border-box;">/** * ${tags} * ${see_to_target} */</span> </code><ul class="pre-numbering" style="box-sizing: border-box; position: absolute; width: 50px; top: 0px; left: 0px; margin: 0px; padding: 6px 0px 40px; border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); list-style: none; text-align: right; background-color: rgb(238, 238, 238);"><li style="box-sizing: border-box; padding: 0px 5px;">1</li><li style="box-sizing: border-box; padding: 0px 5px;">2</li><li style="box-sizing: border-box; padding: 0px 5px;">3</li><li style="box-sizing: border-box; padding: 0px 5px;">4</li></ul>

GET方法标签：

<code class="hljs java has-numbering" style="display: block; padding: 0px; color: inherit; box-sizing: border-box; font-family: 'Source Code Pro', monospace;font-size:undefined; white-space: pre; border-top-left-radius: 0px; border-top-right-radius: 0px; border-bottom-right-radius: 0px; border-bottom-left-radius: 0px; word-wrap: normal; background: transparent;"><span class="hljs-javadoc" style="color: rgb(136, 0, 0); box-sizing: border-box;">/** *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @return</span> ${bare_field_name} */</span> </code><ul class="pre-numbering" style="box-sizing: border-box; position: absolute; width: 50px; top: 0px; left: 0px; margin: 0px; padding: 6px 0px 40px; border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); list-style: none; text-align: right; background-color: rgb(238, 238, 238);"><li style="box-sizing: border-box; padding: 0px 5px;">1</li><li style="box-sizing: border-box; padding: 0px 5px;">2</li><li style="box-sizing: border-box; padding: 0px 5px;">3</li></ul>

SET方法标签：

<code class="hljs java has-numbering" style="display: block; padding: 0px; color: inherit; box-sizing: border-box; font-family: 'Source Code Pro', monospace;font-size:undefined; white-space: pre; border-top-left-radius: 0px; border-top-right-radius: 0px; border-bottom-right-radius: 0px; border-bottom-left-radius: 0px; word-wrap: normal; background: transparent;"><span class="hljs-javadoc" style="color: rgb(136, 0, 0); box-sizing: border-box;">/** *<span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;"> @param</span> ${param} 要设置的 ${bare_field_name} */</span> </code><ul class="pre-numbering" style="box-sizing: border-box; position: absolute; width: 50px; top: 0px; left: 0px; margin: 0px; padding: 6px 0px 40px; border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); list-style: none; text-align: right; background-color: rgb(238, 238, 238);"><li style="box-sizing: border-box; padding: 0px 5px;">1</li><li style="box-sizing: border-box; padding: 0px 5px;">2</li><li style="box-sizing: border-box; padding: 0px 5px;">3</li></ul>

配置模版

<code class="hljs scala has-numbering" style="display: block; padding: 0px; color: inherit; box-sizing: border-box; font-family: 'Source Code Pro', monospace;font-size:undefined; white-space: pre; border-top-left-radius: 0px; border-top-right-radius: 0px; border-bottom-right-radius: 0px; border-bottom-left-radius: 0px; word-wrap: normal; background: transparent;"><?xml version=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"1.0"</span> encoding=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"UTF-8"</span> standalone=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"no"</span>?><templates><template autoinsert=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> context=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"gettercomment_context"</span> deleted=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> description=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"Comment for getter method"</span> enabled=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> id=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"org.eclipse.jdt.ui.text.codetemplates.gettercomment"</span> name=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"gettercomment"</span>><span class="hljs-javadoc" style="color: rgb(136, 0, 0); box-sizing: border-box;">/** * getter method * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@return</span> the ${bare_field_name} */</span></template><template autoinsert=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> context=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"settercomment_context"</span> deleted=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> description=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"Comment for setter method"</span> enabled=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> id=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"org.eclipse.jdt.ui.text.codetemplates.settercomment"</span> name=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"settercomment"</span>><span class="hljs-javadoc" style="color: rgb(136, 0, 0); box-sizing: border-box;">/** * setter method * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@param</span> ${param} the ${bare_field_name} to set */</span></template><template autoinsert=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> context=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"constructorcomment_context"</span> deleted=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> description=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"Comment for created constructors"</span> enabled=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> id=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"org.eclipse.jdt.ui.text.codetemplates.constructorcomment"</span> name=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"constructorcomment"</span>><span class="hljs-javadoc" style="color: rgb(136, 0, 0); box-sizing: border-box;">/**  * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@Title</span> ${enclosing_type}.   * &lt;p&gt;Title: &lt;/p&gt;  * &lt;p&gt;Description: &lt;/p&gt;  * ${tags}  */</span></template><template autoinsert=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> context=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"filecomment_context"</span> deleted=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> description=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"Comment for created Java files"</span> enabled=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> id=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"org.eclipse.jdt.ui.text.codetemplates.filecomment"</span> name=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"filecomment"</span>><span class="hljs-javadoc" style="color: rgb(136, 0, 0); box-sizing: border-box;">/** * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@Title</span>: ${file_name} * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@Package</span> ${package_name} * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@Description</span>: ${todo} * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@author</span> username * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@date</span> ${date} * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@version</span> V1.0 */</span></template><template autoinsert=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> context=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"typecomment_context"</span> deleted=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> description=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"Comment for created types"</span> enabled=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> id=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"org.eclipse.jdt.ui.text.codetemplates.typecomment"</span> name=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"typecomment"</span>><span class="hljs-javadoc" style="color: rgb(136, 0, 0); box-sizing: border-box;">/**  * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@ClassName</span>: ${type_name}  * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@Description</span>: ${todo}  * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@author</span> username  * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@date</span> ${date} ${time}  * ${tags}  */</span></template><template autoinsert=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> context=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"fieldcomment_context"</span> deleted=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> description=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"Comment for fields"</span> enabled=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> id=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"org.eclipse.jdt.ui.text.codetemplates.fieldcomment"</span> name=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"fieldcomment"</span>><span class="hljs-javadoc" style="color: rgb(136, 0, 0); box-sizing: border-box;">/**  * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@Fields</span> ${field} : ${todo}（用一句话描述这个变量表示什么）  */</span></template><template autoinsert=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> context=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"methodcomment_context"</span> deleted=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> description=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"Comment for non-overriding methods"</span> enabled=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> id=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"org.eclipse.jdt.ui.text.codetemplates.methodcomment"</span> name=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"methodcomment"</span>><span class="hljs-javadoc" style="color: rgb(136, 0, 0); box-sizing: border-box;">/**  * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@Title</span>: ${enclosing_method}  * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@Description</span>: ${todo}  * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@param</span> ${tags}    设定文件  * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@author</span> username  * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@return</span> ${return_type}    返回类型  * <span class="hljs-javadoctag" style="color: rgb(102, 0, 102); box-sizing: border-box;">@throws</span>  */</span></template><template autoinsert=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> context=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"overridecomment_context"</span> deleted=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> description=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"Comment for overriding methods"</span> enabled=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> id=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"org.eclipse.jdt.ui.text.codetemplates.overridecomment"</span> name=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"overridecomment"</span>><span class="hljs-javadoc" style="color: rgb(136, 0, 0); box-sizing: border-box;">/**  * &lt;p&gt;Description: &lt;/p&gt;  * ${tags}  * ${see_to_overridden}  */</span></template><template autoinsert=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> context=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"delegatecomment_context"</span> deleted=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> description=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"Comment for delegate methods"</span> enabled=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> id=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"org.eclipse.jdt.ui.text.codetemplates.delegatecomment"</span> name=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"delegatecomment"</span>><span class="hljs-javadoc" style="color: rgb(136, 0, 0); box-sizing: border-box;">/**  * ${tags}  * ${see_to_target}  */</span></template><template autoinsert=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> context=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"newtype_context"</span> deleted=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> description=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"Newly created files"</span> enabled=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> id=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"org.eclipse.jdt.ui.text.codetemplates.newtype"</span> name=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"newtype"</span>>${filecomment}${package_declaration}${typecomment}${type_declaration}</template><template autoinsert=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> context=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"classbody_context"</span> deleted=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> description=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"Code in new class type bodies"</span> enabled=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> id=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"org.eclipse.jdt.ui.text.codetemplates.classbody"</span> name=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"classbody"</span>></template><template autoinsert=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> context=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"interfacebody_context"</span> deleted=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> description=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"Code in new interface type bodies"</span> enabled=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> id=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"org.eclipse.jdt.ui.text.codetemplates.interfacebody"</span> name=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"interfacebody"</span>></template><template autoinsert=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> context=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"enumbody_context"</span> deleted=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> description=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"Code in new enum type bodies"</span> enabled=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> id=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"org.eclipse.jdt.ui.text.codetemplates.enumbody"</span> name=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"enumbody"</span>></template><template autoinsert=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> context=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"annotationbody_context"</span> deleted=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> description=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"Code in new annotation type bodies"</span> enabled=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> id=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"org.eclipse.jdt.ui.text.codetemplates.annotationbody"</span> name=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"annotationbody"</span>></template><template autoinsert=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> context=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"catchblock_context"</span> deleted=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> description=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"Code in new catch blocks"</span> enabled=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> id=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"org.eclipse.jdt.ui.text.codetemplates.catchblock"</span> name=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"catchblock"</span>><span class="hljs-comment" style="color: rgb(136, 0, 0); box-sizing: border-box;">// ${todo} Auto-generated catch block</span>${exception_var}.printStackTrace();</template><template autoinsert=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> context=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"methodbody_context"</span> deleted=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> description=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"Code in created method stubs"</span> enabled=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> id=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"org.eclipse.jdt.ui.text.codetemplates.methodbody"</span> name=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"methodbody"</span>><span class="hljs-comment" style="color: rgb(136, 0, 0); box-sizing: border-box;">// ${todo} Auto-generated method stub</span>${body_statement}</template><template autoinsert=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> context=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"constructorbody_context"</span> deleted=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"false"</span> description=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"Code in created constructor stubs"</span> enabled=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"true"</span> id=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"org.eclipse.jdt.ui.text.codetemplates.constructorbody"</span> name=<span class="hljs-string" style="color: rgb(0, 136, 0); box-sizing: border-box;">"constructorbody"</span>>${body_statement}<span class="hljs-comment" style="color: rgb(136, 0, 0); box-sizing: border-box;">// ${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></span></code><ul class="pre-numbering" style="box-sizing: border-box; position: absolute; width: 50px; top: 0px; left: 0px; margin: 0px; padding: 6px 0px 40px; border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); list-style: none; text-align: right; background-color: rgb(238, 238, 238);"><li style="box-sizing: border-box; padding: 0px 5px;">1</li><li style="box-sizing: border-box; padding: 0px 5px;">2</li><li style="box-sizing: border-box; padding: 0px 5px;">3</li><li style="box-sizing: border-box; padding: 0px 5px;">4</li><li style="box-sizing: border-box; padding: 0px 5px;">5</li><li style="box-sizing: border-box; padding: 0px 5px;">6</li><li style="box-sizing: border-box; padding: 0px 5px;">7</li><li style="box-sizing: border-box; padding: 0px 5px;">8</li><li style="box-sizing: border-box; padding: 0px 5px;">9</li><li style="box-sizing: border-box; padding: 0px 5px;">10</li><li style="box-sizing: border-box; padding: 0px 5px;">11</li><li style="box-sizing: border-box; padding: 0px 5px;">12</li><li style="box-sizing: border-box; padding: 0px 5px;">13</li><li style="box-sizing: border-box; padding: 0px 5px;">14</li><li style="box-sizing: border-box; padding: 0px 5px;">15</li><li style="box-sizing: border-box; padding: 0px 5px;">16</li><li style="box-sizing: border-box; padding: 0px 5px;">17</li><li style="box-sizing: border-box; padding: 0px 5px;">18</li><li style="box-sizing: border-box; padding: 0px 5px;">19</li><li style="box-sizing: border-box; padding: 0px 5px;">20</li><li style="box-sizing: border-box; padding: 0px 5px;">21</li><li style="box-sizing: border-box; padding: 0px 5px;">22</li><li style="box-sizing: border-box; padding: 0px 5px;">23</li><li style="box-sizing: border-box; padding: 0px 5px;">24</li><li style="box-sizing: border-box; padding: 0px 5px;">25</li><li style="box-sizing: border-box; padding: 0px 5px;">26</li><li style="box-sizing: border-box; padding: 0px 5px;">27</li><li style="box-sizing: border-box; padding: 0px 5px;">28</li><li style="box-sizing: border-box; padding: 0px 5px;">29</li><li style="box-sizing: border-box; padding: 0px 5px;">30</li><li style="box-sizing: border-box; padding: 0px 5px;">31</li><li style="box-sizing: border-box; padding: 0px 5px;">32</li><li style="box-sizing: border-box; padding: 0px 5px;">33</li><li style="box-sizing: border-box; padding: 0px 5px;">34</li><li style="box-sizing: border-box; padding: 0px 5px;">35</li><li style="box-sizing: border-box; padding: 0px 5px;">36</li><li style="box-sizing: border-box; padding: 0px 5px;">37</li><li style="box-sizing: border-box; padding: 0px 5px;">38</li><li style="box-sizing: border-box; padding: 0px 5px;">39</li><li style="box-sizing: border-box; padding: 0px 5px;">40</li><li style="box-sizing: border-box; padding: 0px 5px;">41</li><li style="box-sizing: border-box; padding: 0px 5px;">42</li><li style="box-sizing: border-box; padding: 0px 5px;">43</li><li style="box-sizing: border-box; padding: 0px 5px;">44</li><li style="box-sizing: border-box; padding: 0px 5px;">45</li><li style="box-sizing: border-box; padding: 0px 5px;">46</li><li style="box-sizing: border-box; padding: 0px 5px;">47</li><li style="box-sizing: border-box; padding: 0px 5px;">48</li><li style="box-sizing: border-box; padding: 0px 5px;">49</li><li style="box-sizing: border-box; padding: 0px 5px;">50</li><li style="box-sizing: border-box; padding: 0px 5px;">51</li><li style="box-sizing: border-box; padding: 0px 5px;">52</li><li style="box-sizing: border-box; padding: 0px 5px;">53</li><li style="box-sizing: border-box; padding: 0px 5px;">54</li><li style="box-sizing: border-box; padding: 0px 5px;">55</li><li style="box-sizing: border-box; padding: 0px 5px;">56</li><li style="box-sizing: border-box; padding: 0px 5px;">57</li><li style="box-sizing: border-box; padding: 0px 5px;">58</li><li style="box-sizing: border-box; padding: 0px 5px;">59</li><li style="box-sizing: border-box; padding: 0px 5px;">60</li><li style="box-sizing: border-box; padding: 0px 5px;">61</li><li style="box-sizing: border-box; padding: 0px 5px;">62</li><li style="box-sizing: border-box; padding: 0px 5px;">63</li><li style="box-sizing: border-box; padding: 0px 5px;">64</li><li style="box-sizing: border-box; padding: 0px 5px;">65</li><li style="box-sizing: border-box; padding: 0px 5px;">66</li><li style="box-sizing: border-box; padding: 0px 5px;">67</li><li style="box-sizing: border-box; padding: 0px 5px;">68</li><li style="box-sizing: border-box; padding: 0px 5px;">69</li><li style="box-sizing: border-box; padding: 0px 5px;">70</li><li style="box-sizing: border-box; padding: 0px 5px;">71</li><li style="box-sizing: border-box; padding: 0px 5px;">72</li><li style="box-sizing: border-box; padding: 0px 5px;">73</li><li style="box-sizing: border-box; padding: 0px 5px;">74</li><li style="box-sizing: border-box; padding: 0px 5px;">75</li><li style="box-sizing: border-box; padding: 0px 5px;">76</li><li style="box-sizing: border-box; padding: 0px 5px;">77</li><li style="box-sizing: border-box; padding: 0px 5px;">78</li><li style="box-sizing: border-box; padding: 0px 5px;">79</li><li style="box-sizing: border-box; padding: 0px 5px;">80</li><li style="box-sizing: border-box; padding: 0px 5px;">81</li><li style="box-sizing: border-box; padding: 0px 5px;">82</li><li style="box-sizing: border-box; padding: 0px 5px;">83</li><li style="box-sizing: border-box; padding: 0px 5px;">84</li><li style="box-sizing: border-box; padding: 0px 5px;">85</li><li style="box-sizing: border-box; padding: 0px 5px;">86</li><li style="box-sizing: border-box; padding: 0px 5px;">87</li><li style="box-sizing: border-box; padding: 0px 5px;">88</li></ul>

使用说明：

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

尾

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