Quantcast
Channel: 簡睿隨筆
Viewing all articles
Browse latest Browse all 897

由Java原始碼產生類別使用文件:產生Javadoc的步驟 (IDEA #9)

$
0
0

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

解說影片


##

您可能也會有興趣的類似文章


Viewing all articles
Browse latest Browse all 897

Trending Articles