如何為我們的程序編寫開發文檔——Java文檔注釋


Java文檔注釋是用於生成Java API文檔的注釋,通過在程序中的類、屬性、方法部分加上注釋,就可以用javadoc命令生成漂亮的API文檔,是程序員進階的必備技能。

注意,文檔注釋只說明緊跟其后的類、屬性或者方法。
Javadoc文檔生成命令為:

-author和-version可以省略。

根據在文檔中顯示的效果,文檔注釋分為三部分。舉例如下:

第一部分是簡述。如下圖中被紅框框選的部分:
圖片一
簡述部分寫在一段文檔注釋的最前面,第一個點號 (.) 之前 (包括點號).
第二部分是詳細說明部分。該部分對屬性或者方法進行詳細的說明,雅思周末班在格式上沒有什么特殊的要求,可以包含若干個點號。它在文檔中的位置如下圖所示:
圖片二
這部分文檔對應的代碼是:

第三部分是特殊說明部分。這部分包括版本說明、參數說明、返回值說明等。它在文檔中的位置:
圖片三

標記 范圍 作用
@author 標明開發該類的作者
@version 標明該類模塊的版本
@see 類、屬性、方法 參考轉向,也就是相關主題
@param 方法 對方法中參數的說明
@return 方法 對方法返回值的說明
@exception 方法 對方法可能拋出的異常說明
     

除上面所寫之外,還有javadoc命令等詳細參數沒有介紹,請自行在命令行中使用help命令查看。
關於生成Java文檔,通過命令行進行生成通常只做演示的作用,我們開發所使用的IDE如:IntelliJ IDEA、Eclipse等均集成了文檔生成功能,只需要我們把文檔注釋寫好,然后點擊按鈕即可。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM