eclipsemyeclipse注释模板的修改Word文档格式.docx
《eclipsemyeclipse注释模板的修改Word文档格式.docx》由会员分享,可在线阅读,更多相关《eclipsemyeclipse注释模板的修改Word文档格式.docx(17页珍藏版)》请在冰点文库上搜索。
![eclipsemyeclipse注释模板的修改Word文档格式.docx](https://file1.bingdoc.com/fileroot1/2023-5/5/4782ad92-5732-47a3-bef8-5d7b5600b6d1/4782ad92-5732-47a3-bef8-5d7b5600b6d11.gif)
*类描述:
*创建人:
${user}
*创建时间:
${date}${time}
*修改人:
*修改时间:
*修改备注:
*@version
*/
----------------------------------------------------------------------------------------------------------
设置注释模板的入口:
Window->
Preference->
Java->
CodeStyle->
CodeTemplate然后展开Comments节点就是所有需设置注释的元素啦。
现就每一个元素逐一介绍:
文件(Files)注释标签:
*@Title:
${file_name}
*@Package${package_name}
*@Description:
${todo}(用一句话描述该文件做什么)
*@authorA18ccmsA18ccms_gmail_com
*@date${date}${time}
*@versionV1.0
类型(Types)注释标签(类的注释):
/**
*@ClassName:
${type_name}
${todo}(这里用一句话描述这个类的作用)
*@authorA18ccmsa18ccms_gmail_com
*
*${tags}
字段(Fields)注释标签:
*@Fields${field}:
${todo}(用一句话描述这个变量表示什么)
构造函数标签:
*<
p>
Title:
<
/p>
Description:
方法(Constructor&
Methods)标签:
${enclosing_method}
${todo}(这里用一句话描述这个方法的作用)
*@param${tags}
设定文件
*@return${return_type}
返回类型
*@throws
覆盖方法(OverridingMethods)标签:
/*(非Javadoc)
${enclosing_method}<
*${see_to_overridden}
代表方法(DelegateMethods)标签:
*${see_to_target}
getter方法标签:
*@return${bare_field_name}
setter方法标签:
*@param${param}要设置的${bare_field_name}
简单模板例子:
viewplaincopytoclipboardprint?
<
?
xmlversion="
1.0"
encoding="
UTF-8"
>
templates>
templateautoinsert="
true"
context="
fieldcomment_context"
deleted="
false"
description="
字段的注释"
enabled="
id="
org.eclipse.jdt.ui.text.codetemplates.fieldcomment"
name="
fieldcomment"
/template>
gettercomment_context"
getter方法的注释"
org.eclipse.jdt.ui.text.codetemplates.gettercomment"
gettercomment"
constructorcomment_context"
创建的构造函数的注释"
org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
constructorcomment"
${file_name}<
构造函数<
filecomment_context"
已创建的Java文件的注释"
org.eclipse.jdt.ui.text.codetemplates.filecomment"
filecomment"
*@authorDAIGUANGJIU
settercomment_context"
setter方法的注释"
org.eclipse.jdt.ui.text.codetemplates.settercomment"
settercomment"
*/<
typecomment_context"
创建的类型的注释"
org.eclipse.jdt.ui.text.codetemplates.typecomment"
typecomment"
*@author${user}
delegatecomment_context"
代表方法的注释"
org.eclipse.jdt.ui.text.codetemplates.delegatecomment"
delegatecomment"
overridecomment_context"
覆盖方法的注释"
org.eclipse.jdt.ui.text.codetemplates.overridecomment"
overridecomment"
/**(非Javadoc)
methodcomment_context"
非覆盖方法的注释"
org.eclipse.jdt.ui.text.codetemplates.methodcomment"
methodcomment"
/templa
*@versionV1.0
例子2:
template
autoinsert="
Commentforcreatedconstructors"
/**
*创建一个新的实例${enclosing_type}.
*
*${tags}
*/
Commentforsettermethod"
*@param${param}the${bare_field_name}toset
template
Commentfornon-overridingmethods"
*此方法描述的是:
*@author:
wangxiongdx@
*@version:
${date}${time}
Commentfordelegatemethods"
*${see_to_target}
CommentforcreatedJavafiles"
*文件名:
${file_name}
*版本信息:
*日期:
${date}
*Copyright足下Corporation${year}
*版权所有