文档章节

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
博文 24
码字总数 3505
作品 0
温州
程序员
扩展 JDT 实现自动代码注释与格式化

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

红薯
2010/07/30
1K
1
eclipse添加注释模板

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

liuzs1208
2014/06/12
0
0
Eclipse的常用功能

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

pmos
2016/08/02
68
0
以简单的方式消除 Java 的冗长

Lombok 是一种 Java Archive (JAR) 文件,可用来消除 Java 代码的冗长。 我们看这样一个例子,一个标准的 Java bean。一个典型的 Java bean 一般具有几个属性。每个属性具有一个 accessor 和...

红薯
2010/04/13
1K
6
提高Java代码质量的Eclipse插件之Checkstyle的使用详解

CheckStyle是SourceForge下的一个项目,提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程,从而使得开发人员从这项重要但是枯燥的任务中解脱出来。 CheckS...

ArlenXu
2016/05/16
69
2

没有更多内容

加载失败,请刷新页面

加载更多

下一页

nginx模块学习六 add_header 跨域访问

语法 Syntax: add_header name value [always];Default: --Context:http,server,location,if in location 例:/etc/nginx/conf.d/default.conf server {    listen       80; ......

Romanceling
今天
0
0
SpringBoot初探

#SpringBoot初探 三种创建SpringBoot项目的方式: 第一种:使用IDEA创建maven项目,选择maven-archetype-quickstart; 第二种:使用IDEA创建Spring Initializer,选择web组件; 第三种:使用...

向码而生
今天
2
0
IO

JAVA中IO技术:BIO、NIO、AIO 1、同步异步、阻塞非阻塞概念 同步和异步是针对应用程序和内核的交互而言的。 阻塞和非阻塞是针对于进程在访问数据的时候,根据IO操作的就绪状态来采取的不同方...

DemonsI
今天
0
0
org.apache.commons 常用工具类

一. org.apache.commons.io.IOUtils closeQuietly 关闭一个IO流、socket、或者selector且不抛出异常。通常放在finally块。 toString 转换IO流、 Uri、 byte[]为String。 copy IO流数据复制,...

sprouting
今天
0
0
linux使用Inotify监控目录或者文件状态变更

基本概念: Inotify 是一个 Linux特性,它监控文件系统操作,比如读取、写入和创建。Inotify 反应灵敏,用法非常简单,并且比 cron 任务的繁忙轮询高效得多。 需求: 1.有一个文件采集进程,...

mickelfeng
今天
0
1

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部