Javadoc是什麼?
優良的程式除了易讀、容易維護外,註解同樣扮演重要角色。Java定義一組稱為Javadoc的註解規範,只要遵循這些規範,就能輕鬆將原始碼裡的註解產生成說明的網頁檔案。
Javadoc註解必須放在class、方法或類別變數前面,以/**
開頭,以*/
結尾,註解裡可使用下列常用標籤(完整清單:Javadoc标签表):
註解標籤 | 功能 |
---|---|
@author | 作者姓名 |
@version | 版本資訊 |
@param | 參數說明 |
@return | 傳回值說明 |
IDEA產生Javadoc步驟
功能表 【Tools】→【Generate JavaDoc…】,在對話窗輸入下列選項:
- Output directory:產生網頁的存放資料夾
- Locale:語系,zh_TW、zh_CN、en_US等
- Other command line auguments:-encoding UTF-8
解說影片
##
您可能也會有興趣的類似文章
- [IntelliJ IDEA] Java / JavaScript除錯小技巧 (0則留言, 2014/08/14)
- 用IntelliJ IDEA寫第一支Java程式;程式結構說明;Live Tempate用法(IDEA #4) (0則留言, 2019/08/09)
- Java的資料型態與簡單的計算機程式 (IDEA #8) (0則留言, 2019/08/25)
- IntelliJ IDEA Live Template(即時樣板)的使用與範例說明(IDEA #5) (0則留言, 2019/08/11)
- 如何在啟動IntelliJ IDEA idea64.exe時指定特定JDK (0則留言, 2015/11/14)
- 使用IntelliJ IDEA學習Java程式設計 (IDEA #1) (0則留言, 2019/07/14)
- 使用IntelliJ IDEA 12的Android UI Designer輕鬆寫Android App (1則留言, 2012/08/09)
- [Windows] 刪除特定Java process的方法 (0則留言, 2017/08/02)
- IntelliJ IDEA逐步除錯的步驟與除錯演練(IDEA #7) (0則留言, 2019/08/18)
- IntelliJ IDEA的專案結構、模組設定與執行時組態設定(IDEA教學 #6) (0則留言, 2019/08/17)
- IntelliJ IDEA的啟動設定與建議安裝的外掛(IDEA #3) (0則留言, 2019/07/21)
- 第一次執行IntelliJ IDEA與初始設定(IDEA #2) (0則留言, 2019/07/14)
- IntelliJ IDEA直接開啟專案的方法 (0則留言, 2010/06/03)
- 原來IntelliJ IDEA也有中文的網站 (0則留言, 2008/08/22)
- 由桌面啟動IntelliJ IDEA 14 64-bit執行檔 (0則留言, 2014/11/07)