文档章节

eclipse 添加注释

郑泮勇
 郑泮勇
发布于 2014/10/14 23:05
字数 784
阅读 29
收藏 0
点赞 0
评论 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>


© 著作权归作者所有

共有 人打赏支持
郑泮勇
粉丝 2
博文 24
码字总数 3505
作品 0
温州
程序员
扩展 JDT 实现自动代码注释与格式化

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

红薯 ⋅ 2010/07/30 ⋅ 1

eclipse添加注释模板

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

liuzs1208 ⋅ 2014/06/12 ⋅ 0

Eclipse的常用功能

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

pmos ⋅ 2016/08/02 ⋅ 0

提高Java代码质量的Eclipse插件之Checkstyle的使用详解

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

ArlenXu ⋅ 2016/05/16 ⋅ 2

Eclipse中java文件头注释格式设置

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

robert.liu ⋅ 2015/10/08 ⋅ 0

详细讲解Maven插件MyBatis-Generator以及如何修改源码

1、常用使用方式: mybatis-generator有三种用法:命令行、eclipse插件、maven插件。个人觉得maven插件最方便,可以在eclipse/intellij idea等ide上可以通用。 命令行: java -jar mybatis-...

woter ⋅ 2016/09/28 ⋅ 0

以简单的方式消除 Java 的冗长

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

红薯 ⋅ 2010/04/13 ⋅ 6

Eclipse/MyEclipse注释模板和格式化模板的使用

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

Carl_ ⋅ 2015/06/09 ⋅ 0

Eclipse代码注释时@author默认值Administrator修改

我们在写代码注释时经常会出现 author,这个author默认的$(user)名也是Administrator 如果要修改这个名的话, 可以这样做: 打开eclipse安装目录下的eclipse.ini文件, 在文件的末尾添加: -Du...

GeminiLiu ⋅ 2014/01/02 ⋅ 0

【腾讯定位SDK】prguard混淆产生警告或出错

使用v3.x版本时,proguard需要添加以下配置: 原因 v3.x版本中使用了 方法,它是 api level 18 中新添加的,所以低版本的SDK(低于 api level 18)混淆时会因此产生警告甚至出错。 --- 使用v4....

chenming ⋅ 2014/09/24 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

Docker Swarm的前世今生

概述 在我的《Docker Swarm集群初探》一文中,我们实际体验了Docker Swarm容器集群技术的魅力,与《Kubernetes实践录》一文中提到的Kubernetes集群技术相比,Docker Swarm没有Kubernetes显得...

CodeSheep ⋅ 今天 ⋅ 0

骰子游戏代码开源地址

因为阿里云现在服务器已经停用了,所以上面的配置已经失效。 服务端开源地址:https://gitee.com/goalya/chat4.git 客户端开源地址:https://gitee.com/goalya/client4.git 具体运行界面请参考...

算法之名 ⋅ 今天 ⋅ 0

设计模式--装饰者模式

装饰者模式 定义 动态地给一个对象添加一些额外的职责。就增加功能来说,装饰模式相比生成子类更为灵活。 通用类图 意图 动态地给一个对象添加一些额外的职责。就增加功能来说,装饰模式相比...

gaob2001 ⋅ 今天 ⋅ 0

JavaScript零基础入门——(八)JavaScript的数组

JavaScript零基础入门——(八)JavaScript的数组 欢迎大家回到我们的JavaScript零基础入门,上一节课我们讲了有关JavaScript正则表达式的相关知识点,便于大家更好的对字符串进行处理。这一...

JandenMa ⋅ 今天 ⋅ 0

sbt网络问题解决方案

转自:http://dblab.xmu.edu.cn/blog/maven-network-problem/ cd ~/.sbt/launchers/0.13.9unzip -q ./sbt-launch.jar 修改 vi sbt/sbt.boot.properties 增加一个oschina库地址: [reposit......

狐狸老侠 ⋅ 今天 ⋅ 0

大数据,必须掌握的10项顶级安全技术

我们看到越来越多的数据泄漏事故、勒索软件和其他类型的网络攻击,这使得安全成为一个热门话题。 去年,企业IT面临的威胁仍然处于非常高的水平,每天都会看到媒体报道大量数据泄漏事故和攻击...

p柯西 ⋅ 今天 ⋅ 0

Linux下安装配置Hadoop2.7.6

前提 安装jdk 下载 wget http://mirrors.hust.edu.cn/apache/hadoop/common/hadoop-2.7.6/hadoop-2.7.6.tar.gz 解压 配置 vim /etc/profile # 配置java环境变量 export JAVA_HOME=/opt/jdk1......

晨猫 ⋅ 今天 ⋅ 0

crontab工具介绍

crontab crontab 是一个用于设置周期性被执行的任务工具。 周期性执行的任务列表称为Cron Table crontab(选项)(参数) -e:编辑该用户的计时器设置; -l:列出该用户的计时器设置; -r:删除该...

Linux学习笔记 ⋅ 今天 ⋅ 0

深入Java多线程——Java内存模型深入(2)

5. final域的内存语义 5.1 final域的重排序规则 1.对于final域,编译器和处理器要遵守两个重排序规则: (1)在构造函数内对一个final域的写入,与随后把这个被构造对象的引用赋值给一个引用...

江左煤郎 ⋅ 今天 ⋅ 0

面试-正向代理和反向代理

面试-正向代理和反向代理 Nginx 是一个高性能的反向代理服务器,但同时也支持正向代理方式的配置。

秋日芒草 ⋅ 今天 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部