注释模板规范java.docx
- 文档编号:9198399
- 上传时间:2023-02-03
- 格式:DOCX
- 页数:10
- 大小:16.33KB
注释模板规范java.docx
《注释模板规范java.docx》由会员分享,可在线阅读,更多相关《注释模板规范java.docx(10页珍藏版)》请在冰豆网上搜索。
注释模板规范java
设置注释模板的入口:
Window->Preference->Java->CodeStyle->CodeTemplate然后展开Comments节点就是所有需设置注释的元素。
每一个元素逐一介绍:
文件(Files)注释标签:
/**
*@Project:
${project_name}
*@Title:
${file_name}
*@Package${package_name}
*@Description:
${todo}
*@authorjeffshawjeff_chon@
*@date${date}${time}
*@Copyright:
${year}Inc.Allrightsreserved.
*@versionV1.0
*/
类(Types)注释标签(类的注释):
/**
*@ClassName:
${type_name}
*@Description:
${todo}
*@authorjeffshawjeff_chon@
*@date${date}${time}
*
*${tags}
*/
字段(Fields)注释标签:
/**
*@Fields${field}:
${todo}
*/
构造函数标签:
/**
*
Title:
*
Description:
*${tags}
*/
方法(Constructor&Methods)标签:
/**
*@Title:
${enclosing_method}
*@Description:
${todo}
*@param${tags} 设定文件
*@return${return_type} 返回类型
*@throws
*/
覆盖方法(OverridingMethods)标签:
/*(非Javadoc)
*
Title:
${enclosing_method}
*
Description:
*${tags}
*${see_to_overridden}
*/
代表方法(DelegateMethods)标签:
/**
*${tags}
*${see_to_target}
*/
getter方法标签:
/**
*@return${bare_field_name}
*/
setter方法标签:
/**
*@param${param}要设置的${bare_field_name}
*/
简单模板例1:
xmlversion="1.0"encoding="UTF-8"?
>
*@Fields${field}:
${todo}(用一句话描述这个变量表示什么)
*/
*@return${bare_field_name}
*/
*
Title:
${file_name}
*
Description:
构造函数
*${tags}
*/
*@Title:
${file_name}
*@Package${package_name}
*@Description:
${todo}(用一句话描述该文件做什么)
*@authorjeffshawemail:
jeff_chon@
*@date${date}${time}
*@versionV1.0
*/
*@param${param}要设置的${bare_field_name}
*/
*@author${user}
*
*${tags}
*/
*${tags}
*${see_to_target}
*/
*
Title:
${enclosing_method}
*
Description:
*${tags}
*${see_to_overridden}
*/
*${tags}
*/
xmlversion="1.0"encoding="UTF-8"?
>
*@Fields${field}:
${todo}(用一句话描述这个变量表示什么)
*/
*@return${bare_field_name}
*/
*
Title:
${file_name}
*
Description:
构造函数
*${tags}
*/
*@Title:
${file_name}
*@Package${package_name}
*@Description:
${todo}(用一句话描述该文件做什么)
*@authorjeffshawemail:
jeff_chon@
*@date${date}${time}
*@versionV1.0
*/
*@param${param}要设置的${bare_field_name}
*/
*@author${user}
*
*${tags}
*/
*${tags}
*${see_to_target}
*/
*
Title:
${enclosing_method}
*
Description:
*${tags}
*${see_to_overridden}
*/
*${tags}
*/
简单模板2:
xmlversion="1.0"encoding="UTF-8"?
>
autoinsert="false" context="constructorcomment_context" deleted="false" description="Commentforcreatedconstructors" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment"> /** *创建一个新的实例${enclosing_type}. *${tags} */
autoinsert="true" context="settercomment_context" deleted="false" description="Commentforsettermethod" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment"> /** *@param${param}the${bare_field_name}toset */
autoinsert="false" context="methodcomment_context" deleted="false" description="Commentfornon-overridingmethods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment"> /** *此方法描述的是: *@author: jeffwhawemail: jeff_chon@ *@version: ${date}${time} */
autoinsert="true" context="delegatecomment_context" deleted="false" description="Commentfordelegatemethods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment"> /** *${tags} *${see_to_target} */
autoinsert="false" context="filecomment_context" deleted="false" description="CommentforcreatedJavafiles" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment"> /** *文件名: ${file_name} * *版本信息: *日期: ${date} *CopyrightCorporation${year} *版权所有 * */
autoinsert="false" context="gettercomment_context" deleted="false" description="Commentforgettermethod" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment"> /** *${bare_field_name} * *@returnthe${bare_field_name} *@since CodingExampleVer(编码范例查看)1.0 */
autoinsert="true" context="overridecomment_context" deleted="false" description="Commentforoverridingmethods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment"> /*(non-Javadoc) *${see_to_overridden} */
autoinsert="false" context="fie
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 注释 模板 规范 java