原文網址：https://www.jianshu.com/p/06153fabcad3
一、插件說明
JavaDoc
添加注釋，可自定義模板。
插件下載地址：https://plugins.jetbrains.com/plugin/?idea_ce&pluginId=7157
插件源碼地址：https://github.com/setial/intellij-javadocs
推薦指數： 五星
二、插件安裝
Android Studio: File → Settings → Plugins → Browse repositories 搜索插件名【JavaDoc】 並安裝
或者
Android Studio: 下載jar文件 並安裝
File → Settings → Plugins → Install plugin from disk (選本地插件包)安裝即可。
三、插件使用
1、注釋快捷鍵
Windows電腦：在方法上面輸入快捷鍵 alt+ctrl+shift+G 即可自動生成注釋，或者按alt+insert調出對話框，手動選擇。
Mac電腦：在方法上面輸入快捷鍵 alt+command+shift+G 即可自動生成注釋，或者按command+N調出對話框，手動選擇。
command_N.png
2、生成javadoc文檔
在Android studio中進行打開一個項目的文件之后，然后進行點擊Android stuio中菜單中的“tools”的選項。
Tools.png
這樣就會彈出了下拉菜單中，進行選中下拉菜單中的“generate javadoc”的選項。
Generate JavaDoc.png
就會彈出了specify generate javadoc scope的窗口，在output directorys中進行輸出的路徑。
OutputPath.png
可在運行的窗口中查看到的是文件正在生成，根據文件大小，對生成的時間上等待。
progress.png
文件生成完畢之后，進入到了resource的文件，進行雙擊index.html的選項即可。
index.png
這樣就同index.html中查看代碼中所有類的方法，如果有添加注釋的信息，也可查看到。
javadoc.png
四、小技巧
1、解決使用Android Studio導出JavaDoc時中文亂碼問題
導出過程中，在Other command line arguments欄目添加命令參數：
-encoding UTF-8 -charset UTF-8（如果是GBK，參數為 -encoding GBK -charset GBK）
默認是中文文檔，添加 -locale en_US 生成英文文檔
或者在Locate欄目添加 en_US
2、command+J：調出系統注釋選擇項
system_ annotation.png
3、類注釋代碼
/** * @Author: ${USER} * @Time: ${DATE} ${TIME} * @Company：公司名稱 * @Description: 功能描述 */ 
File Header.png
4、類似主題優秀文檔參考
作者：Jason_hzb
鏈接：https://www.jianshu.com/p/06153fabcad3
來源：簡書
著作權歸作者所有。商業轉載請聯系作者獲得授權，非商業轉載請注明出處。