eclipse中注释的设置

article/2025/10/19 3:15:58

具体参数设置请参考文章: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就行了。

设置注释模板的入口: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><templateautoinsert="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><templateautoinsert="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><templateautoinsert="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><templateautoinsert="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><templateautoinsert="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><templateautoinsert="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><templateautoinsert="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><templateautoinsert="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><templateautoinsert="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>

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

 

 

<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>

 

 

 


http://chatgpt.dhexx.cn/article/9sMcW2lI.shtml

相关文章

Eclipse设置代码自动注释

Eclipse自动注释设置 1.如何设置方法步骤实现注释自动生成配置内容 2.其他更改author ${user} 3.效果图4.其他设置 1.如何设置 方法步骤 下面的配置&#xff08;其中&#xff1a;Types是针对类&#xff0c;Methods是针对方法&#xff09;&#xff0c;说多了都是废话&#xff…

eclipse如何修改注释

本人想重点说明的是&#xff0c;在使用下面方法后注释还未达到预期的效果&#xff0c;可以修改eclipse.ini文件&#xff08;在eclipse的安装目录下&#xff09;&#xff0c;然后重启就可以了。 方法一&#xff1a;Eclipse中设置在创建新类时自动生成注释 windows-->prefer…

eclipse文档注释设置、文件(Files)注释标签、类型(Types)注释标签(类的注释)、字段(Fields)注释标签、构造函数(Constructor)标签

文章目录 1.文件(Files)注释标签2.类型(Types)注释标签&#xff08;类的注释&#xff09;3.字段(Fields)注释标签4.构造函数(Constructor)标签5.方法(Methods)标签6.覆盖方法(Overriding Methods)标签7.代理方法(Delegate Methods)标签8.getter方法标签9.setter方法标签 设置注…

Eclipse注释详解

一、背景简介 丰富的注释和良好的代码规范&#xff0c;对于代码的阅读性和可维护性起着至关重要的作用。几乎每个公司对这的要求还是比较严格的&#xff0c;往往会形成自己的一套编码规范。但是再实施过程中&#xff0c;如果全靠手动完成&#xff0c;不仅效率低下&#xff0c;还…

eclipse多行注释 (eclipse开发工具)

eclipse为多行添加注释是有快捷方式可用的&#xff0c;了解了这个快捷方式相信很多网友都会大大提高编码效率&#xff0c;其实同时为多行添加注释可以分别添加“/* */”和“//”样式的&#xff0c;样式不同快捷键也会不同&#xff0c;下面我们可以一起看看具体的添加注释方法。…

eclipse中自动添加注释方法

一、在eclipse 中多行注释快捷键 1.选中你要加注释的区域&#xff0c;用ctrlshiftC 或者ctrl/ 会加上//注释 2.先把你要注释的东西选中&#xff0c;用shitctrl/ 会加上/* */注释 3.以上快捷在重复按一下就会去掉加上的注释 4. 在eclispe中的设定快捷键方式&#xff1a;进入…

Eclipse配置代码注释模板 Eclipse代码注释模板 Eclipse设置方法注释模板

Eclipse配置代码注释模板 Eclipse代码注释模板 Eclipse设置方法注释模板 一、前言 1、在日常的团队开发中&#xff0c;都会有相应的的代码开发规范模板&#xff1b;在不同的IDE中配置方式又是不一样的&#xff0c;本文简单记录下如何在Eclipse中配置代码注释模板。 二、模板配置…

eclipse注释的快捷键有哪些?

代码注释分为单行注释“//”和多行注释“/* */”&#xff0c;以下是一些注释的快捷键。 1、Ctrl/ 2、CtrlShiftC 3、Ctrl7 4、CtrlShift/ 前三种都是单行注释&#xff0c;最后一种是多行注释。 举个例子&#xff1a; 1、拖动鼠标选中要注释掉的代码区域&#xff1a; 键盘上按…

Eclipse中关于添加注释的各种方法

2012年01月09日 ⁄ Android, Linux开发 ⁄ 暂无评论 热度: &#xff08;1&#xff09;多行注释 Ctrl/ &#xff08;2&#xff09;在方法名之前/**&#xff0c;然后回车&#xff0c;如果方法已经写实现了&#xff0c;就不会自动出来了 &#xff08;3&#xff09;在方法名之前 …

Eclipse 设置注释模板

一、为何配置注释模板 在工作中我们需要在必要的地方添加注释以便于自己和其他人理解代码&#xff0c;这就是注释的主要功能&#xff0c;我们不希望发生几个月后只有上帝知道我们的代码是什么意思的情况&#xff0c;那将充分的证明代码不够优雅。 二、模板的内容是什么 模板…

Eclipse代码注释配置(超详细)

目录 1、eclipse用户名的设置2、添加模板3、测试注释 1、eclipse用户名的设置 打开Eclipse安装目录&#xff0c;找到eclipse.ini文件打开 2、添加模板 选择要生效的项目&#xff0c;然后双击项目点进去 勾上 一般我们注释在方法上和类上添加即可&#xff0c;其他的在现实开发当…

Eclipse设置注释信息

1、在最上面的工具栏里找到Window下的Preferences。如下图&#xff1a; 2、进入Java—Code Style—Code Templates—Comments&#xff0c;修改Comments里面的注释模板。如图&#xff1a; ① Files【文件注释】 /*** Title: ${file_name}* Package: ${package_name}* Descripti…

eclipse给方法添加自动注释

4&#xff0c;自动生成注释 在团队开发中&#xff0c;注释是必不可少的&#xff0c;要不然&#xff0c;换个人维护代码只能“呵呵”了。由于大家都写注释&#xff0c;所以对注释的格式应该统一。我们可以使用Eclipse注释模板自动生成注释。 打开注释模板编辑窗口&#xff1a;W…

eclipse代码注释的设置

1. eclipse用户名的设置&#xff1a; 在eclipse的安装路径下&#xff0c;打开eclipse.ini的配置文件&#xff0c;如下图&#xff1a; 在-vmargs下加入&#xff1a;-Duser.name你的名字 2. 注释格式以及各个主要简介 &#xff08;1&#xff09;.单行(single-line)注释&#xff1…

Eclipse 中添加注释,注释中包含作者时间等

Eclipse 中添加注释&#xff0c;注释中包含作者时间等 在使用Eclipse工作是&#xff0c;为了防止有人程序报错甩锅给自己&#xff0c;我们一般都会在Eclipse中添加注释&#xff0c;注释内容一般包括&#xff1a;作者、时间、类别、版本号等&#xff0c;来鉴别区分。 下面我来介…

【eclipse修改默认注释】

【eclipse修改默认注释】 一、背景简介 丰富的注释和良好的代码规范&#xff0c;对于代码的阅读性和可维护性起着至关重要的作用。几乎每个公司对这的要求还是比较严格的&#xff0c;往往会形成自己的一套编码规范。但是再实施过程中&#xff0c;如果全靠手动完成&#xff0c;不…

eclipse中注释的技巧

首先eclipse中有三种注释 1Add block comment 添加块注释 选中多行 按下快捷键 形成形如“/**/”的注释 默认快捷键 添加注释&#xff1a;ctrlshift/ 取消注释&#xff1a;ctrlshift\ 2toggle comment &#xff08;绿色注释&#xff09; 也可以多行&#xff08;前提是选中…

测试用例的设计要素以及设计测试用例的方法

本篇文章主要是为了讲述测试用例的设计要素以及设计方法 1、定义&#xff1a;测试用例是为了达到特定的目的而设计的一组测试输入、执行条件和预期结果的文档。 2、设计测试用例的要素&#xff1a;&#xff08;有八大要素&#xff09; ①、用例编号&#xff1a;也就是用例的i…

测试用例设计方法有哪些?举例说明

众所周知&#xff0c;测试用例是编制的一组测试输入、执行条件及预期结果&#xff0c;专门为的是某个特殊目标&#xff0c;即测试某个程序路径&#xff0c;或是核实是否满足某个特定的需求。一般来讲&#xff0c;常用的测试用例设计方法有五种&#xff0c;分别是&#xff1a;正…