前言
JavaDoc 不會影響 Java 中的性能，因為在編譯時會刪除所有注釋．編寫注釋和 JavaDoc 是為了更好理解程式碼，從而更好地維護程式碼．(取自維基百科)
平常寫程式碼時會加入註解，作用是為了未來可以更好的維護．而 JavaDoc 是針對 Class 或方法的簡單說明及提示，當滑鼠移動到選中項目時就會跳出提示．
 |
| 滑鼠移動到項目產生 JavaDoc 提示 |
常見的 JavaDoc 標籤
不會所有的標籤都使用到，根據需要加入即可．
Android Studio 基本設定
模板小技巧
詳細的操作可以點選連結查看
詳細介紹 ，項目分別為 Another Setting Doc, Fix Doc Comments，下方會列出基本設定的截圖．以模板的方式，可以有效節省時間．
1. 定義 Class
 |
| Preferences -> Class 設定 |
 |
設定模板 (可自行增, 刪)
綠色文字為模板固定字串，每次產生出來都會相同
紫色文字則依據當前時間跟檔案名稱自動產生 |
 |
| 新增 Class 自動產生模板 |
 |
紅框處有自動換行，是因為有加入 <p>...<p/>
沒有額外加入，所有的內容會只呈現在同一行，不會分段 |
2. 定義文件內的結構
Live Template 設定技巧，可以查看 Live Template 詳細設定 ，以下只列出基本設定．
 |
| Preferences -> Live Templates |
 |
Template Group... 新增 BossCare(可以自訂名稱)
Live Template 為 method |
 |
模板的設定
紫色文字為 ＄錢字號 前後包著變數，讓系統產生需要額外設定 |
 |
| 變數設定，可以使用下拉選單來選擇 |
 |
| 輸入 method 會有提示字跳出 |
 |
| 點選 Tab 自動產生模板 |
以上的模板小技巧，只是為了節省時間，若有缺少的標籤或沒有使用到的標籤，還是需要去手動去做修改，可以自行評估是否需要建立．
易混淆標籤說明
(1) @link 以及 ＠see
 |
@see 需要擺在開頭
{＠link} 則是可以放在文字的後方，方便調整位置 |
 |
文件產生出來的結果
＠see 會變成 See Also:
{@link} 則沒有限制，可以自行調整
點選連結就會前往設定的位置 |
@link 跟 ＠see 的用法是
需要先輸入檔案的位置如 com.froggy.nsfw_gbike.MainActivity
 |
| 這個部分系統會提示 |
接著輸入＃符號，選擇要連結的項目
 |
| 系統同樣會提示 |
 |
點選 Tab 後，com.froggy.nsfw_gbike.MainActivity
路徑會被取代成 MainActivity |
(2) ＠version 以及 ＠since (個人用法)
 |
@version 只要檔案有修正就會同步去更新
只放在定義 Class 類型檔案上 |
 |
| @since 則是放在 function 上，提示是在哪一個版本加入的 |
Generate JavaDoc (產生 JavaDoc)
 |
沒有限制，全部設定完成才執行 Generate JavaDoc...
可以嘗試去執行，如果有錯誤會有提示 |
 |
| Tools -> Generate JavaDoc... |
 |
| 調整基本設定 |
 |
| 需要注意 encoding 部分 |
 |
需要選擇檔案儲存位置否則無法點選 OK
紅框處設定要注意，可以自行調整及勾選 |
 |
| 產生檔案完成後會有提示 |
 |
| 自動開啟產生的文件 |
如何查看儲存的文件
 |
到輸出的檔案路徑查看，開啟 index.html 即可
|
 |
| 檔案效果 |
後記
如果這篇文章對於你有幫助，可以幫忙分享給更多的人．文章內容如果有誤，可以在下方留言告知．本網站主要提供程式相關資訊，想獲得最即時的資訊，可以訂閱透過 email 閱讀．
留言
張貼留言