文档章节

eclipse 添加注释

郑泮勇
 郑泮勇
发布于 2014/10/14 23:05
字数 784
阅读 30
收藏 0

I. 如何自动添加注释

可通过如下三种方法自动添加注释:
1. 输入“/**”并回车。
2. 用快捷键 Alt+Shift+J。
3. 在右键菜单中选择“Source > Generate Element Comment”。

II. 如何自定义注释格式

通过菜单 Window->Preference 打开参数设置面板,然后选择:
Java -> Code Style -> Code Templates

在右侧选择Comments,将其中的Files项,然后选右边的"Edit",进入编辑模式:   

进入编辑模式后就可以自定义注释了。另外可以插入一些变量,如年、日期等等。

最后,确保 Code -> New Java files 中有:"${filecomment}"

III. 导入/导出代码格式模板

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


操作步骤:打开Window->Preferences->Java->Code Style->Code Templates

如图:

 

 

点击“Import”,导入模板codetemplates.xml文件。

 

附:codetemplates.xml文件内容


<?xml version= "1.0"  encoding= "UTF-8"  standalone= "no" ?><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" > /**
  * <b>项目名:</b>系统项目名称<br/>
  * <b>包名:</b>${package_name}<br/>
  * <b>文件名:</b>${file_name}<br/>
  * <b>版本信息:</b><br/>
  * <b>日期:</b>${date}-${time}<br/>
  * <b>Copyright (c)</b> ${year}XX公司-版权所有<br/>
  *
  */ </template><template autoinsert= "true"  context= "filecomment_context"  deleted= "false"  description= "Comment for created JavaScript files"  enabled= "true"  id= "org.eclipse.wst.jsdt.ui.text.codetemplates.filecomment"  name= "filecomment" > /**
  *
  */ </template><template autoinsert= "true"  context= "delegatecomment_context"  deleted= "false"  description= "Comment for delegate functions"  enabled= "true"  id= "org.eclipse.wst.jsdt.ui.text.codetemplates.delegatecomment"  name= "delegatecomment" > /**
  * ${tags}
  * ${see_to_target}
  */ </template><template autoinsert= "false"  context= "typecomment_context"  deleted= "false"  description= "Comment for created types"  enabled= "true"  id= "org.eclipse.wst.jsdt.ui.text.codetemplates.typecomment"  name= "typecomment" > /**
  * @author kin
  *
  * ${tags}
  */ </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" > /**
  *
  * <b>类名称:</b>${type_name}<br/>
  * <b>类描述:</b><br/>
  * <b>创建人:</b>kin<br/>
  * <b>修改人:</b>kin<br/>
  * <b>修改时间:</b>${date} ${time}<br/>
  * <b>修改备注:</b><br/>
  * @version 1.0.0<br/>
  *
  */ </template><template autoinsert= "true"  context= "fieldcomment_context"  deleted= "false"  description= "Comment for vars"  enabled= "true"  id= "org.eclipse.wst.jsdt.ui.text.codetemplates.fieldcomment"  name= "fieldcomment" > /**
  *
  */ </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= "true"  context= "overridecomment_context"  deleted= "false"  description= "Comment for overriding functions"  enabled= "true"  id= "org.eclipse.wst.jsdt.ui.text.codetemplates.overridecomment"  name= "overridecomment" > /* (non-Jsdoc)
  * ${see_to_overridden}
  */ </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><template autoinsert= "true"  context= "settercomment_context"  deleted= "false"  description= "Comment for setter function"  enabled= "true"  id= "org.eclipse.wst.jsdt.ui.text.codetemplates.settercomment"  name= "settercomment" > /**
  * @param ${param} the ${bare_field_name} to set
  */ </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" > /**
  * ${bare_field_name}
  *
  * @return  the ${bare_field_name}
  * @since   1.0.0
*/
</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" > /**
  * ${enclosing_method}(这里用一句话描述这个方法的作用)<br/>
  * (这里描述这个方法适用条件 – 可选)<br/>
  * ${tags}
  *${return_type}
  * @exception
  * @since  1.0.0
*/ </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= "true"  context= "constructorcomment_context"  deleted= "false"  description= "Comment for created constructors"  enabled= "true"  id= "org.eclipse.wst.jsdt.ui.text.codetemplates.constructorcomment"  name= "constructorcomment" > /**
  * ${tags}
  */ </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" > /* (non-Javadoc)
  * ${see_to_overridden}
  */ </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" > /**
  * ${field}:${todo}(用一句话描述这个变量表示什么)
  *
  * @since 1.0.0
  */
</template><template autoinsert= "true"  context= "gettercomment_context"  deleted= "false"  description= "Comment for getter function"  enabled= "true"  id= "org.eclipse.wst.jsdt.ui.text.codetemplates.gettercomment"  name= "gettercomment" > /**
  * @return the ${bare_field_name}
  */ </template><template autoinsert= "true"  context= "methodcomment_context"  deleted= "false"  description= "Comment for non-overriding function"  enabled= "true"  id= "org.eclipse.wst.jsdt.ui.text.codetemplates.methodcomment"  name= "methodcomment" > /**
  * ${tags}
  */ </template></templates>


本文转载自:http://blog.sina.com.cn/s/blog_a449972001010h6n.html

共有 人打赏支持
郑泮勇
粉丝 2
博文 37
码字总数 4653
作品 0
温州
程序员
私信 提问
eclipse添加注释模板

写代码,一定要添加注释,一是方便自己以后使用,二是方便别人维护 注释有一定格式,反反复复敲键盘或者copy ,也有点烦。 有了注释模板,打上注释标签,自动完成注释格式,是很省心的。 把一...

liuzs1208
2014/06/12
0
0
扩展 JDT 实现自动代码注释与格式化

简介: 本文介绍了一个为 Eclipse 工作空间中的 Java 代码自动添加统一注释并格式化排版的工具及其具体实现。该工具扩展 Eclipse Java Development Tool(JDT)API,操作 Java 代码。通过本文...

红薯
2010/07/30
1K
1
Eclipse的常用功能

1、eclipse的基础 不要使用中文版 1.1、workspace 所有的开发项目都需要在workspace中,记住workspace放置在一个不会被删除的目录中 改变workspace 1.2、project eclipse和大多数IDE一样,都...

pmos
2016/08/02
68
0
Eclipse中java文件头注释格式设置

Eclipse中java文件头注释格式设置 Eclipse中java文件头注释格式设置 windows->preferences->java->Code Templates->comments->Type->edit Eclipse注释规范模版总结 新建类文件 / @ClassName......

robert.liu
2015/10/08
4.6K
0
Eclipse/MyEclipse注释模板和格式化模板的使用

在一个项目的完整的生命周期中,其维护费用,往往是其开发费用的数倍。因此项目的可维护性、可复用性是衡量一个项目好坏的关键。而注释则是可维护性中必不可少的一环。 注释模板导入步骤 安装...

Carl_
2015/06/09
0
0

没有更多内容

加载失败,请刷新页面

加载更多

CentOS配置Tomcat监听80端口,虚拟主机

Tomcat更改默认端口为80 更改的配置文件是: /usr/local/tomcat/conf/server.xml [root@test-a ~]# vim /usr/local/tomcat/conf/server.xml # 找到 Connector port="8080" protocol="HTTP/1......

野雪球
今天
5
0
《稻盛和夫经营学》读后感心得体会3180字范文

《稻盛和夫经营学》读后感心得体会3180字范文: 一代日本经营之圣稻盛和夫凭借刻苦勤奋的精神以及深植于佛教的商业道德准则,成为了“佛系”企业家的代表人物。在《稻盛和夫经营学》“领导人...

原创小博客
今天
3
0
java框架学习日志-5(常见的依赖注入)

依赖注入(dependency injection) 之前提到控制反转(Inversion of Control)也叫依赖注入,它们其实是一个东西,只是看的角度不同,这章详细说一下依赖注入。 依赖——指bean对象创建依赖于...

白话
今天
4
0
红外接收器驱动开发

背景:使用系统的红外遥控软件没有反应,然后以为自己接线错误,反复测试,结果烧坏了一个红外接收器,信号主板没有问题。所以自己开发了一个红外接收器的python驱动。接线参见https://my.os...

mbzhong
今天
2
0
ActiveMQ消息传送机制以及ACK机制详解

AcitveMQ是作为一种消息存储和分发组件,涉及到client与broker端数据交互的方方面面,它不仅要担保消息的存储安全性,还要提供额外的手段来确保消息的分发是可靠的。 一. ActiveMQ消息传送机...

watermelon11
今天
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部