eclipse中注释的设置

具体参数设置请参考文章：http://blog.csdn.net/shiyuezhong/article/details/8450578

（1）在方法或者属性上面添加注释：

在方法或者属性字段的上面一行输/**，然后回车。一般情况下添加的注释格式如下所示，当然注释的格式是可以修改的：

1 2 3 4 5

/** * @param * @return * @throws Exception */

（2）在文件头添加注释：

用快捷键Alt＋Shift+J可以为文件头快速添加注释。

（3）修改注释的格式：

添加的注释格式是可以修改的，通过菜单Window->Preference打开参数设置面板，然后选择：Java -> Code Style -> Code Templates，在右侧选择Comments就可以修改注释的格式。如下图所示：



（4）添加注释的种类：

从上图可以看到添加注释的有Files（文件）注释，Types（类）注释，Fields（属性）注释等。

（5）导出和导入注释：

通过导出和导入功能，可以把自己的模板导出来在其他机器上使用

（6）注释变量的设置

我们在写代码注释时经常会出现author，这个author默认的$(user)名也是Administrator。

如果要修改这个名的话，可以这样做，打开eclipse安装目录下的eclipse.ini文件，在文件的末尾添加：

-Duser.name=your name

然后重启eclipse就行了。关于eclipse.ini文件的介绍，请看后续文章。

声明: 本文由金丝燕网原创编译，转载请保留链接: Eclipse添加注释简介

设置注释模板的入口：Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素。本文现就每一个元素逐一给大家介绍一下。

文件(Files)注释标签：

1 2 3 4 5 6 7 8

/** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo}(用一句话描述该文件做什么) * @author ${user} * @date ${date} * @version V1.0 */

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

1 2 3 4 5 6 7 8

/** * @ClassName: ${type_name} * @Description: ${todo}(这里用一句话描述这个类的作用) * @author ${user} * @date ${date} * * ${tags} */

字段(Fields)注释标签：

1 2 3

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

构造函数(Constructor)标签：

1 2 3 4 5

/** * 创建一个新的实例 ${enclosing_type}. * * ${tags} */

方法(Methods)标签：

1 2 3 4 5 6 7

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

覆盖方法(Overriding Methods)标签：

1 2 3 4 5 6

/* (非 Javadoc) * <p>Title: ${enclosing_method}</p> * <p>Description: </p> * ${tags} * ${see_to_overridden} */

代理方法(Delegate Methods)标签：

1 2 3 4

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

getter方法标签：

1 2 3

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

setter方法标签：

1 2 3

/** * @param ${param} the ${bare_field_name} to set */

要实现上面的注释模板，这需要将下面的配置文件导入就可以了：

<?xmlversion="1.0"encoding="UTF-8"?>
<templates>
<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 ${user}
* @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 ${user}
* @date ${date}
*
* ${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="constructorcomment_context"
deleted="false"
description="Comment for created constructors"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
name="constructorcomment">
/**
* 创建一个新的实例 ${enclosing_type}.
*
* ${tags}
*/
</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}    参数
* @return ${return_type}    返回类型
* @throws
*/
</template>
<template
autoinsert="true"
context="overridecomment_context"
deleted="false"
description="Comment for overriding methods"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"
name="overridecomment">
/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
</template>
<template
autoinsert="true"
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="false"
context="gettercomment_context"
deleted="false"
description="Comment for getter method"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"
name="gettercomment">
/**
* @return ${bare_field_name}
*/
</template>
<template
autoinsert="true"
context="settercomment_context"
deleted="false"
description="Comment for setter method"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.settercomment"
name="settercomment">
/**
* @param ${param} the ${bare_field_name} to set
*/
</template>
</templates>

声明: 本文由金丝燕网原创编译，转载请保留链接: Eclipse注释模板设置详解

另外需要注意的是：上面的文件需要重新排版，你们可以根据最初的样式排版文件，按照自己的需求排版，现在我就贴出我的排版，主要还是根据上面的文件的基础上排版。

<span style="font-size:14px;"><?xml version="1.0" encoding="UTF-8"?>
<templates>
<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 ${user}
* @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 ${user}
* @date ${date}
*
* ${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="constructorcomment_context"
deleted="false" description="Comment for created constructors"
enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
name="constructorcomment">/**
* 创建一个新的实例 ${enclosing_type}.
*
* ${tags}
*/</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} 参数
* @return ${return_type} 返回类型
* @throws
*/</template>
<template autoinsert="true" context="overridecomment_context"
deleted="false" description="Comment for overriding methods" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/* (非 Javadoc)
*
<p>Title: ${enclosing_method}</p>
*
<p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/</template>
<template autoinsert="true" 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="false" context="gettercomment_context"
deleted="false" description="Comment for getter method" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
* @return ${bare_field_name}
*/</template>
<template autoinsert="true" context="settercomment_context"
deleted="false" description="Comment for setter method" enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**
* @param ${param} the ${bare_field_name} to set
*/</template>
</templates></span>