posts - 165, comments - 198, trackbacks - 0, articles - 1
            BlogJava :: 首頁(yè) :: 新隨筆 :: 聯(lián)系 :: 聚合  :: 管理

          eclipes javadoc 使用

          Posted on 2007-10-22 16:47 G_G 閱讀(939) 評(píng)論(0)  編輯  收藏 所屬分類(lèi): javaGeneral
          1。項(xiàng)目中 ->Exprot.. -> @javadoc 就可以了
          2。javadoc 命令學(xué)習(xí)
          ??? @author 作者
          ??? @see 另請(qǐng)參見(jiàn)
          ??? ??? (1)、@see "string" 為"string"添加文本項(xiàng),不產(chǎn)生鏈接。
          ??? ??? (2)、@see <a href="URL#Value">Label</a> 使用HTML標(biāo)記產(chǎn)生鏈接
          ??? ??? (3)、@see package.class#member Label 使用Java語(yǔ)言的名字package.class #member產(chǎn)生鏈接。

          @version 版
          ??? @since 從以下版本開(kāi)
          ??? @param 參數(shù)說(shuō)明

          /** */中的開(kāi)頭是注解

          ?? /**
          ?? */? 的就近原則 在那個(gè)上面就為那個(gè)注解

          參照:http://java.ccidnet.com/art/3743/20031203/519697_1.html

          /** class description
          */


          3、Variable Description:描述變量的意義和取值含義。
          /** var variable description
          */

          4、Method Description:標(biāo)明每個(gè)方法的輸入、輸出參數(shù)和返回值類(lèi)型,說(shuō)明特殊變量取值的含義。相關(guān)類(lèi)文檔鏈接。

          /** method description
          * @param var signification 方法參數(shù)說(shuō)明
          * @exception exception class name throws 說(shuō)明
          * @return return_value return signification return 說(shuō)明
          */

          5、Association Description:關(guān)聯(lián)類(lèi)文檔描述,在注釋當(dāng)中需要參引其它文檔描述的地方,可在相應(yīng)的注釋當(dāng)中如下插入:
          /** method description

          * @param var signification
          * @exception exception class name
          * @return return_value return signification
          * @see package.class#member label
          */

          6、包描述文件:概括描述包的功能和設(shè)計(jì)概要。為每個(gè)包創(chuàng)建一個(gè)描述文件,命名為package.html,與包的java文件放在一起。



          ???

          主站蜘蛛池模板: 锡林浩特市| 弥勒县| 连江县| 富川| 青冈县| 乌审旗| 申扎县| 临江市| 庆云县| 刚察县| 金华市| 章丘市| 广元市| 盐津县| 随州市| 蒙山县| 永清县| 三门县| 克拉玛依市| 枣阳市| 大丰市| 宿迁市| 阿鲁科尔沁旗| 大埔区| 肇庆市| 建平县| 荥经县| 纳雍县| 扶绥县| 兰西县| 湛江市| 诸暨市| 宜宾市| 台北县| 永清县| 如皋市| 长丰县| 涡阳县| 七台河市| 泗阳县| 逊克县|