當前位置:編程學習大全網 - 源碼下載 - java高手:javadoc 在哪個文件夾中,它的作用是什麽

java高手:javadoc 在哪個文件夾中,它的作用是什麽

在JDK目錄下的bin子目錄中

Javadoc是Sun公司提供的壹個技術,它從程序源代碼中抽取類、方法、成員等註釋形成壹個和源代碼配套的API幫助文檔。也就是說,只要在編寫程序時以壹套特定的標簽作註釋,在程序編寫完成後,通過Javadoc就可以同時形式程序的開發文檔了。

JBuilder提供了多項對Javadoc支持的功能,可以通過向導在工程窗格的樹中創建Javadoc的節點,通過節點的菜單命名創建工程的Javadoc文檔,可以通過誘導的方式錄入Javadoc的標簽,檢驗註釋是否和源代碼相匹配等。

本文,我們將講解如何在源代碼中用Javadoc標簽寫註釋及如何創建Javadoc文檔。

雖然軟件工程中把詳細設計作為軟件項目的壹個重要的階段,但在實踐中往往沒有得到落實。並不是這個階段不重要,而是實施有很大的困難,因為軟件需求是天生的易動癥患者,好不容易詳細設計出來後,需求已和當初的版本大相徑庭,而花費巨大,精雕細琢的詳細設計已變成昨日黃花了。

Javadoc註釋由Javadoc標簽和描述性文本組成,妳可以為類、接口添加註釋,也可為構造函數、值域、方法等類中的元素添加註釋。

可以通過代碼模板快速的錄入Javadoc註釋,妳也可以選擇通過Javadoc對話框以壹種形象化的方式錄入Javadoc註釋。此外,JBuilder還提供了各種Javadoc的輔助功能,如JavadocInsight誘導錄入,沖突報告和更正,特殊的todo標簽等。

雖然在Java文件中編寫註釋後,馬上可以切換到內容窗格的Doc視圖頁代碼中對應的Javadoc文檔,但在Doc視圖頁中生成的文檔僅是不完整的"範本"。首先,沒有導航樹,其次沒有生成通過@see或@link關聯內容的鏈接。所以妳可以把Doc視圖頁中的Javadoc文檔看成是Javadoc最終版本的預覽。

本文中我們介紹了Javadoc的標簽,講解了如何在JBuilder編輯Javadoc註釋,妳應該盡量使用JavadocInsight、ClassInsight和ParameterInsight快速而正確地編寫Javadoc註釋。此外妳應該將常用的註釋做成模板,方便快速錄入。

JBuilder提供的註釋沖突報告和恢復的功能可以使妳輕松解決註釋沖突的問題,免除了單調的手工調整操作。

JBuilder還允許妳自定義Javadoc標簽,以滿足壹些個性化的要求。此外JBuilder自定義的todo標簽可以使妳隨時隨地在需要的地方作上標記,不至於遺漏未盡的工作。

  • 上一篇:漂亮的登陸頁面源代碼
  • 下一篇:暢銷言情小說(愛與欲望交織的糾纏情緣)
  • copyright 2024編程學習大全網