jar包添加javadoc注释文档.doc

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

1、Andｒoiｄ设置外源JAR包的说明文档将已有项目注释1注释文档的格式1．1ｊavadoc　文档注视中用到的(前面加＠符号)author作者名veｒsioｎ标明该类模块的版本4。0pａｒaｍeter对方法中某参数的说明　since最早使用该方法/类/接口的JDＫ版本return对方法返回值的说明throwｓ异常类及抛出条件ｄeprecated　引起不推荐使用的警告seeｒｅfeｒenｃｅ　参考转向,也就是相关主题　override重写当前用到的只有这些，更多请参考hｔｔp:/／baｉkｅ。baiｄu。com/viｅw／97５838。htｍ1．２注释文档

2、将用来生成ＨTMＬ格式的代码报告,所以注释文档必须书写在类、域、构造函数、方法、定义之前.注释文档由两部分组成——描述、块标记.需注意：写在目标之后的将无法自动生成对应的JAVADOC文件,即生成时报错.例如:/＊＊＊The　doGeｔmethodｏf　tｈeｓervleｔ．ﻫ＊Thｉｓmethoｄ　ｉsｃalｌeｄ　wｈen　ａ　forｍhas　its　ｔagvaｌｕｅｍeｔｈodｅquａｌs　toget.＊＠ｐａraｍ　rｅqueｓt*　the　reｑuｅsｔ　send　ｂyｔhe　client　ｔo　ｔhesｅｒver*＠paraｍreｓｐoｎs

3、e＊tｈerespｏｎｓｅsendｂｙtheserverto　tｈeclient＊　＠tｈrowsServletＥxcｅption*ifanerror　ｏccurred＊@ｔhroｗs　IOExcｅpｔｉon*if　ａn　ｅrｒor　occurrｅd＊/pubｌｉｃvｏｉddｏＧet（HttｐＳeｒvletRｅquｅstrequest,HttｐServｌｅｔReｓｐｏnseｒeｓｐonse）thrｏws　ＳervｌetExceｐｔiｏn,　IＯExｃepｔion｛doPｏst（rｅquｅst,rｅsｐonse)；｝前两行为描述，描述完毕后，由@符号起头

4、为块标记注释。２注释的种类2。１文件头注释文件头注释以／*开始，以*/结束,需要注明该文件创建时间，文件名，命名空间信息.例如：/*＊Cｒeａtedon20０5-7－2*/2．2　类、接口注释类、接口的注释采用/＊*…*/，描述部分用来书写该类的作用或者相关信息,块标记部分必须注明作者和版本。说明：公司的格式化规范里有这个,导入前可以自己修改作者名及当前版本号/**＊ｃom.examplｅ.ａnｄrｏidｊａvａｄoｃexａmｐle。ＭainＡｃtiｖity　*@auｔhorxｉasiming〈ｂr/>*@versionVerｓｉｏn１．0０　　<ｂr

5、/＞＊crｅａｔe　aｔ20１2－1１—9　上午11：04：03*／2。３构造函数注释构造函数注释采用/**…*／,描述部分注明构造函数的作用，不一定有块标记部分。例如:/**＊默认构造函数＊／又例如：/＊＊*　带参数构造函数,初始化模式名，名称和数据源类型＊　＠paramschｅma*Reｆ模式名*　＠ｐaram　nａｍｅ＊　Ref　名称＊@parａmｔｙpe*byVaｌ数据源类型*/2。４域注释域注释可以出现在注释文档里面，也可以不出现在注释文档里面。用/*＊…　＊／的域注释将会被认为是注释文档热出现在最终生成的HTＭL报告里面，而使用/＊…*/的

6、注释会被忽略.例如:/＊**TｈeX－cｏｏｒｄiｎateofthｅ　compoｎent.*＊@sｅｅ＃getLocation(）＊／intｘ＝126３73２；2.5方法注释方法注释采用／*＊…*/,描述部分注明方法的功能，块标记部分注明方法的参数，返回值，异常等信息。例如:／＊＊＊设置是否有外码约束*＊@pａramcｏｎn*Coｎnecｔiｏｎ与数据库的连接＊／２.６定义注释规则同域注释。3注释块标记3.１　标记的顺序块标记将采用如下顺序:…＊*＠ｐaｒam（classｅｓ，inｔerfaces,　mｅtｈods　aｎd　ｃonｓtｒucｔｏｒson

7、ly）＊＠reｔｕrn(methｏdsonly）＊＠exceｐtioｎ（@ｔhrowｓis　a　sｙnonyｍａddeｄｉnJavadoc　1.２)＊　@authoｒ（clａssesandinｔｅrfaｃesonly,required)*＠vｅｒsｉon(cｌasｓｅsandinterfａｃｅｓoｎｌy，　requireｄ。Seefoｏtｎote1)＊＠see＊　＠since＊@seｒｉａl(or　＠seriａｌFieldor＠seriａlData)＊　＠deｐrecated　（seeHow　andＷｈenToＤeprｅcａteＡPIｓ)*…一个块标记

8、可以根据需要重复出现多次,多次出现的标记按照如下顺序:＠autｈｏr　按照时间先后顺序（cｈｒ