1、java方法注释模板竭诚为您提供优质文档/双击可除java,方法注释模板篇一:java注释模板java,方法注释模板)lsecontext=delegatecomment_contextdeleted=falsedescription=commentfordelegatemethodsenabled=trueid=org.eclipse.jdt.ui.text.codetemplates.delegatecommentname=delegatecomment/*$tags*$see_to_target*/name=constructorcomment/*title:*description:*
2、$tags*/*Fields$field:$todo*/*文件名称:$file_name*文件描述:$todo*版权所有:版权所有(c)$year*内容摘要:简要描述本文件的内容,包括主要模块、函数及能的说明*其他说明:其它内容的说明*完成日期:$date*修改记录1:*修改日期:*修改人:*修改内容:*修改记录2:*authorlishenyun*/*param$paramthe$bare_field_nametoset*/*author:lishenyun*date:$date*description:方法功能描述*$tags:返回结果描述*return$return_type:返回值类型
3、*throws*/*文件名称:$file_name*文件描述:本类描述*版权所有:版权所有(c)$year*内容摘要:简要描述本文件的内容,包括主要模块、函数及能的说明*其他说明:其它内容的说明*完成日期:$date$time*修改记录1:*修改日期:*修改人:*修改内容:*修改记录2:*authorlishenyun*/id=org.eclipse.jdt.ui.text.codetemplates.overridecommentname=overridecomment/*(非javadoc)*title:$enclosing_method*description:*$tags*$see_t
4、o_overridden*/*returnthe$bare_field_name*/【把此文件格式改为xml,导入即可】篇二:java文件头注释格式myeclipse中java文件头注释格式设置20xx-10-0813:11:33|分类:ide|举报|字号订阅windows-preferences-java-codetemplates-comments-type-editeclipse注释规范模版总结新建类文件/*classname:$file_name*description:$todo(用一句话描述该文件做什么)*author$user*versionV1.0*date$date$time
5、*/方法/*title:$enclosing_method*description:$todo(这里用一句话描述这个方法的作用)*param:$tags*return:$return_type*throws*author$user*date$date$time*/输入设置模板:/*$file_namecreateon$date*copyright(c)$datebytaotaosoft*authorjerryli*version1.0*/注意选择自动添加注释养成一个规范的习惯是最好的。选菜单windows-preferencejava-codestyle-codetemplatescode-n
6、ewjavafiles选中点编辑$filecomment$package_declaration/*author作者姓名e-mail:email地址*version创建时间:$date$time*类说明*/$typecomment$type_declarationeclipse注释规范模版总结1、具体操作(1)在eclipse中,打开window-preference-java-codestyle-codetemplate(2)然后展开comments节点就是所有需设置注释的元素,参照2注释规范对应设置即可2、注释规范(1)文件(Files)注释标签/*Filename:$file_name*
7、description:$todo(用一句话描述该文件做什么)*allrightsReserved,designedbyzte-its*copyright:copyright(c)20xx-20xx*companyzte-itswuxiltd.*author:名字*versionV1.0*createdate:$date$time*modificationhistory:*dateauthorVersiondiscription*$datewu.zh1.01.0*why&whatismodified:*/(2)类型(types)注释标签(类的注释):/*classname:$type_name
8、*description:$todo(这里用一句话描述这个类的作用)*author:android_Robot*date:$date$time*$tags*/(3)字段(Fields)注释标签:/*Fields$field:$todo(用一句话描述这个变量表示什么)*/(4)构造函数标签:/*title:$enclosing_type*description:$todo(这里用一句话描述这个方法的作用)*param:$tags*throws*/(5)方法(methods)标签:/*title:$enclosing_method*description:$todo(这里用一句话描述这个方法的作用
9、)*param:$tags*return:$return_type*throws*/(6)覆盖方法(overridingmethods)标签:/*title:$enclosing_method*description:*$tags*$see_to_overridden*/(7)代表方法(delegatemethods)标签:/*$tags*$see_to_target*/(8)getter方法标签:/*title:$enclosing_method*description:pleasewriteyourdescription*return:$field_type*/(9)setter方法标签:
10、/*title:$enclosing_method*description:pleasewriteyourdescription*return:$field_type*/ren篇三:javadoc命令对注释规范的详细介绍与模板的生成1.注释规范由于生成的文档是html款式,而这些html款式的标识符并非javadoc加的,而是程序员在写注释的时候加上去的。如:需要换行时,不是敲回车符,而是写入,要是要分段,就该当在段前写入.2.javadoc记号由“”及其后所跟的记号类型和专用注释引用组成。javadoc记号有如下这些:author对类的阐明说明该类模板的作者version对类的阐明说明该类模
11、板的版本see对类、属性、方式的阐明参照的转向param对方法的阐明,列举方法中的参数return对方式的阐明,方法中的返回值exception对方法的阐明,列举方法中可能抛出的异常3.下面介绍各javadoc记号的运用注意项:1、see的句法有3种:1).see类名2).see#方法名或属性名3).see类名#方法名或属性名(注:如果是属性名,则只需要写出属性名即可;如果是方法名,则需要写出方法名以及参数类型,没有参数的方式,需要写出一对括号)第2个句法中没有指出类名,则默以为目前类。因此它定义的参照,全转向本类中的属性或者方式。而第3个句法中指出了类名,则不错转向其它类的属性或者方式。2、
12、param、return、exception句法每一个param只能描写方式的1个参数,因此,要是方式需要不止一个参数,就需要不止一次运用param来描写。一个方法中只能有1个return,可以抛出多个异常,需要不止一个exception来描述。4.设置java代码注释的模板设置注释模板的入口:window-preference-java-codestyle-codetemplate然后展开comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:文件(Files)注释标签:/*title:$file_name*package$package_name*description:$
13、todo*authorwuqiong*date$date$time*version*/类型(types)注释标签(类的注释):/*title:$type_name*description:$todo*author$user*date$date$time*$tags*/字段(Fields)注释标签:/*Fields$field*/方法(constructor&methods)标签:/*title:$enclosing_type*description:$todo*$tags$return_type*throws*/覆盖方法(overridingmethods)标签:/*(non-javadoc)*title:$enclosing_method*description:*$tags*$see_to_overridden*/代表方法(delegatemethods)标签:/*$tags*$see_to_target*/模板设计好之后,有两种方法使用:1.输入/*回车;2.shift+alt+j5.模板快速输入alt+/补全增加自己的快捷提示,可以修改现有的