今天是3.8 妇女节。在这举国欢庆的时刻祝天下女人们节日快乐,尤其从事咱们it行业的女程们,这个节日更应该好好休息享受,感受一下节日的欢乐。一入it深似海...今天正好周六,不知各位男程们在工作岗位上加班的可多呢,辛苦辛苦!外面空气似乎不太好,雾霾大有卷土重来之势,这个情况可比韩剧还虐心,哎!废话少说,下面进入正题,今天想讨论的是关于eclipse 中如何设定代码注释模版。
有过开发经验的朋友们,不管是大公司还是小公司,应该对于代码注释都是很重视的,当然这跟每个公司是否重视代码质量有关。一般来说,每个公司甚至每个项目组都会有自己的一套注释模版,用来做代码整体的规范约束,你说底层的码农们每天的工作成果不就是那一行行的code,对吧。在eclipse这样的开发利器帮助下,可以使用IDE来帮助进行代码注释,提升工作效率。
简单的说一下,代码注释会用到的地方有如下几处:新建类,字段,方法...等等。以eclipse为例,使用注释模版有两种方式:第一种是自己新建注释模板的xml文件,第二种在myEclipse中自己编辑,其原理都是一样的。在此不再赘述。下面以xml格式化配置文档作为例子,详细说明一下具体配置。完整的xml见附件。
1.构造方法
<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>
实例:
/**
* 创建一个新的实例 Person.
*
* @param name
* @param age
*/
public Person(String name, int age) {
super();
this.name = name;
this.age = age;
}
2.非重载方法
<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}(这里用一句话描述这个方法的作用)
* (这里描述这个方法适用条件 – 可选)
* (这里描述这个方法的执行流程 – 可选)
* (这里描述这个方法的使用方法 – 可选)
* (这里描述这个方法的注意事项 – 可选)
* ${tags}
* @since CodingExample Ver(编码范例查看) 1.1
*/</template>
实例:
/**
*
* sayHi(这里用一句话描述这个方法的作用)
* (这里描述这个方法适用条件 – 可选)
* (这里描述这个方法的执行流程 – 可选)
* (这里描述这个方法的使用方法 – 可选)
* (这里描述这个方法的注意事项 – 可选)
* @param name
* @return
* @throws Exception
* @since CodingExample Ver(编码范例查看) 1.1
*/
public String sayHi(String name) throws Exception{
return null;
}
3.版本消息
<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">/**
* 文件名:${package_name}.${file_name}
*
* 版本信息:
* 日期:${date} ${time}
* Copyright @湖南新晃侗族自治县农夫 Corporation ${year}
* 版权所有
*/</template>
实例:
/**
* 文件名:yl.yelang.Person.java
*
* 版本信息:
* 日期:Mar 8, 2014 11:34:50 AM
* Copyright @湖南新晃侗族自治县农夫 Corporation 2014
* 版权所有
*/
package yl.yelang;
4 类、接口
<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">/**
* 项目名称:${project_name}
* 类名称:${type_name}
* 类描述:
* 创建人:农夫
* 创建时间:${date} ${time}
* 修改人:${user}
* 修改时间:${date} ${time}
* 修改备注:
* @version Ver 1.0
*/</template>
实例:
/**
* 项目名称:MyEclipseGen
* 类名称:Person
* 类描述:
* 创建人:农夫
* 创建时间:Mar 8, 2014 11:34:50 AM
* 修改人:Administrator
* 修改时间:Mar 8, 2014 11:34:50 AM
* 修改备注:
* @version Ver 1.0
*/
public class Person
上述是比较常用的注释模板,其他的比如set/get方法,重载方法,代理方法,字段等如何配置,可以参考副附件中的xml配置。
附录:Eclipse针对java代码模板的内置变量
注释模板中部分参数详解:
cursor 将编辑器的光标放在这个位置。 N/A
date 插入当前日期。
dollar 插入货币的文字符号。 $
elemType 尝试猜测具有给定 ID 的这个元素的类型。 MyType
enclosing_method 插入模板被插入其中的那个方法的名称。 method()
enclosing_method_arguments 为包围方法插入参数。 arg1, arg2
enclosing_package 插入当前类的包名。 com.example.ui
enclosing_project 插入包含所编辑的这个类的项目的名称。 myProject
enclosing_type 插入正在编辑的类型(类)的名称。 MyType
exception_variable_name 插入一个异常变量名称,进行最佳猜测。 e, ioe
file 文件的简称。 MyType.java
import 如果尚未导入,那么针对给定类型插入一个导入声明。 import com.example.ui.MyOtherType
importStatic 与 import 相同,只不过是静态导入。 import static com.example.ui.MyOtherType.*
line_selection 将选中的行插入到这里。这对用模板包装行是很有用的。 以选中行作为主体的 do、while 循环
primary_type_name 没有扩展名的文件简称。 MyType
time 插入当前的时间。
todo 注释中的 TODO 标记。 TODO
user 当前用户的名字。 ngood
var 解析为本地变量,如果不只一个,就提供一个列表。 myvar
word_selection 插入当前选中的单词。 N/A
year 将现在的年份插入到代码中。 2010
说明,上述变量说明摘自:
http://shareal.blog.163.com/blog/static/27659056201193063914196/。
以上就是eclipse中注释模板的配置,记录下来备忘。另外关于如何在eclipse中编辑注释模版,各位朋友可以自己操作,主要参数跟上述的类同。
分享到:
相关推荐
eclipse中java类注释模板,有需要的朋友可以参考使用。
java 注释模版 codetemplates.xml
java注释模版,使程序运行更让人容易看懂,和理解,加快速度
超级好用的 java 注释模板,吐血总结,整理。吐血总结,整理。
java 注释风格和java格式风格模版、简单好用
Java代码、注释模版格式文件
Java完整注释模板,导入Eclipse(MyEclipse)即可以用
eclipse注释模版导入,增加可读性。
JAVA注释模板以及详细设置解释等等。 注释模板 如何设置
java 注释模板 java 注释模板 java 注释模板 java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板java 注释模板
eclipse使用的java代码模版及注释模版,统一java代码风格。
Eclipse注释模版
有关于java的注释规范的详细描述,单行注释、多行注释、分块注释等这些java的三种注释方式
Java注释的良好习惯,方便项目的交接和事后的维护与整理,是一个很好的帮助自己养成编码习惯的工具,效果图在我的博文有记录,有需要的伙伴可以自行下载哦~
Java代码注释率检查器
Eclipse Java 注释模板,设置后可以使用快捷键快速生成文档注释,版本信息等。
在你建立的一个新的Java类时, 当类中有好多注释时你可以见其导入到Eclipse里,每次建类的时候就不用注释了。有JAVA类和方法的注释,很全面,还可以根据你自己的需要进行修改注释
这是本人自己开发的一款java代码注释统计工具,支持统计总行数,总代码行数,总注释行数,注释率,注释合格率自定义,统计详细,单个文件统计情况,可导出统计报告等! 注:本软件未捆绑jre(java环境),需要在已...
eclispe 注释模版eclispe 注释模版eclispe 注释模版eclispe 注释模版eclispe 注释模版eclispe 注释模版