jar包添加javadoc注释文档

《jar包添加javadoc注释文档》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、Android设置外源JAR包的说明文档将已有项目注释1注释文档的格式1.1javadoc文档注视中用到的(前面加@符号)author作者名version标明该类模块的版本4.0parameter对方法中某参数的说明since最早使用该方法/类/接口的JDK版本return对方法返回值的说明throws异常类及抛出条件deprecated引起不推荐使用的警告seereference参考转向，也就是相关主题override重写当前用到的只有这些，更多请参考http://baike.baidu.com/view

2、/975838.htm1.2注释文档将用来生成HTML格式的代码报告，所以注释文档必须书写在类、域、构造函数、方法、定义之前。注释文档由两部分组成——描述、块标记。需注意：写在目标之后的将无法自动生成对应的JAVADOC文件，即生成时报错。例如：/***ThedoGetmethodoftheservlet.*Thismethodiscalledwhenaformhasitstagvaluemethodequalstoget.*@paramrequest*therequestsendbytheclientto

3、theserver*@paramresponse*theresponsesendbytheservertotheclient*@throwsServletException*ifanerroroccurred*@throwsIOException*ifanerroroccurred*/publicvoiddoGet(HttpServletRequestrequest,HttpServletResponseresponse)throwsServletException,IOException{doPost(r

4、equest,response);}前两行为描述，描述完毕后，由@符号起头为块标记注释。2注释的种类2.1文件头注释文件头注释以/*开始，以*/结束，需要注明该文件创建时间，文件名，命名空间信息。例如：/**Createdon2005-7-2*/2.2类、接口注释类、接口的注释采用/**…*/，描述部分用来书写该类的作用或者相关信息，块标记部分必须注明作者和版本。说明：公司的格式化规范里有这个，导入前可以自己修改作者名及当前版本号/***com.example.androidjavadocexample.M

5、ainActivity*@authorxiasiming
*@versionVersion1.00
*createat2012-11-9上午11:04:03*/2.3构造函数注释构造函数注释采用/**…*/，描述部分注明构造函数的作用，不一定有块标记部分。例如：/***默认构造函数*/又例如：/***带参数构造函数,初始化模式名,名称和数据源类型*@paramschema*Ref模式名*@paramname*Ref名称*@paramtype*byVal数据源类型*/2.4域注释域注释可以出现

6、在注释文档里面，也可以不出现在注释文档里面。用/**…*/的域注释将会被认为是注释文档热出现在最终生成的HTML报告里面，而使用/*…*/的注释会被忽略。例如：/***TheX-coordinateofthecomponent.**@see#getLocation()*/intx=1263732;2.5方法注释方法注释采用/**…*/，描述部分注明方法的功能，块标记部分注明方法的参数，返回值，异常等信息。例如：/***设置是否有外码约束**@paramconn*Connection与数据库的连接*/2.6定

7、义注释规则同域注释。3注释块标记3.1标记的顺序块标记将采用如下顺序：…**@param(classes,interfaces,methodsandconstructorsonly)*@return(methodsonly)*@exception(@throwsisasynonymaddedinJavadoc1.2)*@author(classesandinterfacesonly,required)*@version(classesandinterfacesonly,required.Seefootnot

8、e1)*@see*@since*@serial(or@serialFieldor@serialData)*@deprecated(seeHowandWhenToDeprecateAPIs)*…一个块标记可以根据需要重复出现多次，多次出现的标记按照如下顺序：@author按照时间先后顺序（chronological）@param按照参数定义顺序（declaration）@throws按照异常名字的字母顺序（alph