一、插件說明
JavaDoc
添加注釋夺溢,可自定義模板烛谊。
插件下載地址:https://plugins.jetbrains.com/plugin/?idea_ce&pluginId=7157
插件源碼地址:https://github.com/setial/intellij-javadocs
推薦指數(shù): 五星
二、插件安裝
Android Studio: File → Settings → Plugins → Browse repositories 搜索插件名【JavaDoc】 并安裝
或者
Android Studio: 下載jar文件 并安裝
File → Settings → Plugins → Install plugin from disk (選本地插件包)安裝即可状勤。
三、插件使用
1荧降、注釋快捷鍵
Windows電腦:在方法上面輸入快捷鍵 alt+ctrl+shift+G 即可自動(dòng)生成注釋,或者按alt+insert調(diào)出對(duì)話框辛友,手動(dòng)選擇剪返。
Mac電腦:在方法上面輸入快捷鍵 alt+command+shift+G 即可自動(dòng)生成注釋,或者按command+N調(diào)出對(duì)話框邑滨,手動(dòng)選擇钱反。
command_N.png
2面哥、生成javadoc文檔
在Android studio中進(jìn)行打開一個(gè)項(xiàng)目的文件之后,然后進(jìn)行點(diǎn)擊Android stuio中菜單中的“tools”的選項(xiàng)尚卫。
Tools.png
這樣就會(huì)彈出了下拉菜單中吱涉,進(jìn)行選中下拉菜單中的“generate javadoc”的選項(xiàng)。
Generate JavaDoc.png
就會(huì)彈出了specify generate javadoc scope的窗口特石,在output directorys中進(jìn)行輸出的路徑鳖链。
OutputPath.png
可在運(yùn)行的窗口中查看到的是文件正在生成撒轮,根據(jù)文件大小贼穆,對(duì)生成的時(shí)間上等待。
progress.png
文件生成完畢之后顶瞳,進(jìn)入到了resource的文件,進(jìn)行雙擊index.html的選項(xiàng)即可慨菱。
index.png
這樣就同index.html中查看代碼中所有類的方法符喝,如果有添加注釋的信息,也可查看到协饲。
javadoc.png
四茉稠、小技巧
1、解決使用Android Studio導(dǎo)出JavaDoc時(shí)中文亂碼問題
導(dǎo)出過程中铭污,在Other command line arguments欄目添加命令參數(shù):-encoding UTF-8 -charset UTF-8(如果是GBK膀篮,參數(shù)為 -encoding GBK -charset GBK)
2、command+J:調(diào)出系統(tǒng)注釋選擇項(xiàng)
system_ annotation.png
3刁绒、類注釋代碼
/**
* @Author: ${USER}
* @Time: ${DATE} ${TIME}
* @Company:公司名稱
* @Description: 功能描述
*/