Java注释模板

/**
*
* 项目名称：${project_name}
* 类名称：${type_name}
* 类描述：
* 创建人：${user}
* 创建时间：${date} ${time}
* 修改人：${user}
* 修改时间：${date} ${time}
* 修改备注：
* @version
*
*/

----------------------------------------------------------------------------------------------------------

设置注释模板的入口： Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍：

文件(Files)注释标签：

/**

* @Title: ${file_name}

* @Package ${package_name}

* @Description: ${todo}(用一句话描述该文件做什么)

* @author A18ccms A18ccms_gmail_com

* @date ${date} ${time}

* @version V1.0

类型(Types)注释标签（类的注释）：

/**

* @ClassName: ${type_name}

* @Description: ${todo}(这里用一句话描述这个类的作用)

* @author A18ccms a18ccms_gmail_com

* @date ${date} ${time}

* ${tags}

字段(Fields)注释标签：

/**

* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)

构造函数标签：

/**

* <p>Title: </p>

* <p>Description: </p>

* ${tags}

方法(Constructor & Methods)标签：

/**

* @Title: ${enclosing_method}

* @Description: ${todo}(这里用一句话描述这个方法的作用)

* @param ${tags} 设定文件

* @return ${return_type} 返回类型

* @throws

覆盖方法(Overriding Methods)标签：

/* (非 Javadoc)

* <p>Title: ${enclosing_method}</p>

* <p>Description: </p>

* ${tags}

* ${see_to_overridden}

代表方法(Delegate Methods)标签：

/**

* ${tags}

* ${see_to_target}

getter方法标签：

/**

* @return ${bare_field_name}

setter方法标签：

/**

* @param ${param} 要设置的 ${bare_field_name}

简单模板例子：

view plaincopy to clipboardprint?

<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="fieldcomment_context" deleted="false" description="字段的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**

* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)

</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**

* @return ${bare_field_name}

</template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**

* <p>Title:${file_name} </p>

* <p>Description: 构造函数</p>

* ${tags}

</template><template autoinsert="true" context="filecomment_context" deleted="false" description="已创建的 Java 文件的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**

* @Title: ${file_name}

* @Package ${package_name}

* @Description: ${todo}(用一句话描述该文件做什么)

* @author DAIGUANGJIU

* @date ${date} ${time}

* @version V1.0

</template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**

* @param ${param} 要设置的 ${bare_field_name}

*/</template><template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**

* @author ${user}

* ${tags}

*/</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**

* ${tags}

* ${see_to_target}

*/</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖方法的注释" 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="methodcomment_context" deleted="false" description="非覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**

* ${tags}

*/</template></templa

* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)

* @return ${bare_field_name}

* <p>Title:${file_name} </p>

* <p>Description: 构造函数</p>

* ${tags}

* @Title: ${file_name}

* @Package ${package_name}

* @Description: ${todo}(用一句话描述该文件做什么)

* @author DAIGUANGJIU

* @date ${date} ${time}

* @version V1.0

* @param ${param} 要设置的 ${bare_field_name}

* @author ${user}

* ${tags}

* ${see_to_target}

* <p>Title: ${enclosing_method}</p>

* <p>Description: </p>

* ${tags}

* ${see_to_overridden}

* ${tags}

*/</template></templa

例子2：

view plaincopy to clipboardprint?

<?xml version="1.0" encoding="UTF-8"?>

<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="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="false"

context="methodcomment_context"

deleted="false"

description="Comment for non-overriding methods"

enabled="true"

id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"

name="methodcomment">

/**

* 此方法描述的是：

* @author: wangxiongdx@163.com

* @version: ${date} ${time}

</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="filecomment_context"

deleted="false"

description="Comment for created Java files"

enabled="true"

id="org.eclipse.jdt.ui.text.codetemplates.filecomment"

name="filecomment">

/**

* 文件名：${file_name}

* 版本信息：

* 日期：${date}

* Copyright 足下 Corporation ${year}

</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 CodingExample Ver(编码范例查看) 1.0

</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 Ver 1.1

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

/**

* 此类描述的是：

* @author: wangxiongdx@163.com

* @version: ${date} ${time}

</template>

</templates>

本文来自 http://kaminlee.iteye.com/blog/1101938

Java注释模板的更多相关文章

【转】Eclipse Java注释模板设置详解
Eclipse Java注释模板设置详解设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后 ...
Eclipse中设置作者日期等Java注释模板
Eclipse作为JavaIDE(Integrated Development Environment,集成开发环境),可以通过设置自动添加Javadoc注释信息,如@author 作者名.@vers ...
Eclipse Java注释模板设置详解
设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元 ...
Eclipse Java注释模板设置详解，更改 ${user}和${date}
修改MyEclipse eclipse 注释的作者名字转自:http://www.oschina.net/question/158170_31311 在eclipse/myeclipse中,当我们去 ...
[转]Eclipse Java注释模板设置详解
原文链接:http://blog.csdn.net/ahhsxy/archive/2009/09/11/4542682.aspx 设置注释模板的入口: Window->Preference-&g ...
Java注释模板设置详解
设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元 ...
Eclipse Java注释模板设置简介,更改字体大小
为类添加注释:此为我的模板设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments ...
eclipse java 注释模板配置详解
设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元 ...
170828、Eclipse Java注释模板设置详解以及版权声明
编辑注释模板的方法:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素 ...

随机推荐

修改UIBarButtonItem字体大小、颜色等相关属性
在ios中如果想修改UIBarButtonItem里面的内容有很多种方法,常见的就是自定义contentView 但是有时候因为懒不想自定义只想在原来的文字上进行修改如果只是修改UIBarButt ...
【转载】Java的四种引用
在Java中,虽然不需要程序员手动去管理对象的生命周期,但是如果希望某些对象具备一定的生命周期的话(比如内存不足时JVM就会自动回收某些对象从而避免OutOfMemory的错误)就需要用到软引用和弱引 ...
CMD/AMD
AMD 规范在这里:https://github.com/amdjs/amdjs-api/wiki/AMDCMD 规范在这里:https://github.com/seajs/seajs/issues ...
JAXB - XML Schema Types, Binary Data
Data that has no "natural" representation with printable characters must, for inclusion in ...
Extjs3 Combo实现百度搜索查询
在Extjs中实现Combo手输模糊筛选出下拉框数据.之前一直利用的Combo的keyup来实时的请求数据库进行查询.最近发现了一个更好的方式:只需要引用一个ComboBoxQuery Ext.ns( ...
关于H5中的Canvas API的探索
Canvas API 是H5中比较炫酷的一部分内容.可以通过它动态的生成和展示图形.图表.图像以及动画.下面我将学习一下Canvas API. 最后有书籍和源码. 一.概述: 1.基本元素: 在网页上 ...
kettle中Get Data from XML , Jason Input , 文本文件输入使用示例
1.Get Data from XML xml文件内容: <head> <img id="1">菜||焦溜丸子||2013-03-28/image/0/00 ...
Hibernate+struts+JqueryAjax+jSON实现无刷新三级联动
看网上JqueryAjax三级联动的例子讲不是很全,代码也给的不是很全,给初学者带来一定的难度.小弟自己写了一个,可能有些地方不是很好,希望大家能够提出建议. 用的是Hibernate+struts2 ...
input与button按钮背景图失效不显示的解决办法
今天做公司的某个网站前端网页页面的时候笔者又遇到了难解决的网页前端DIVCSS代码问题,一个平时不会发生的怪事情发生了:为网页代码中的Form表单中的input 和 button 按钮标签在CSS样式 ...
Linux中的版本控制---diff和patch命令
一.构造两个用于测试的文件 hello.txt: world.txt: 二.用diff命令比较两个文本文件的差异对这个两个文本文件执行diff‘命令,并通过输出重定向,将差异保存在diff.txt文 ...

Java注释模板

Java注释模板的更多相关文章

随机推荐

热门专题