posts - 165, comments - 198, trackbacks - 0, articles - 1
            BlogJava :: 首頁 :: 新隨筆 :: 聯系 :: 聚合  :: 管理

          eclipes javadoc 使用

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

          @version 版
          ??? @since 從以下版本開
          ??? @param 參數說明

          /** */中的開頭是注解

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

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

          /** class description
          */


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

          4、Method Description:標明每個方法的輸入、輸出參數和返回值類型,說明特殊變量取值的含義。相關類文檔鏈接。

          /** method description
          * @param var signification 方法參數說明
          * @exception exception class name throws 說明
          * @return return_value return signification return 說明
          */

          5、Association Description:關聯類文檔描述,在注釋當中需要參引其它文檔描述的地方,可在相應的注釋當中如下插入:
          /** method description

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

          6、包描述文件:概括描述包的功能和設計概要。為每個包創建一個描述文件,命名為package.html,與包的java文件放在一起。



          ???

          主站蜘蛛池模板: 景宁| 汕尾市| 焦作市| 凤冈县| 饶阳县| 五指山市| 达拉特旗| 孟州市| 桂林市| 佳木斯市| 拜泉县| 文成县| 来宾市| 浏阳市| 织金县| 囊谦县| 揭东县| 宜兴市| 湾仔区| 铜梁县| 济源市| 务川| 白玉县| 容城县| 曲靖市| 内丘县| 东源县| 策勒县| 库伦旗| 嘉兴市| 广水市| 中超| 政和县| 沂源县| 衡南县| 揭西县| 五指山市| 宜宾市| 崇阳县| 福鼎市| 五常市|