剛開始學習Android,使用了Android Studio IDE。為了將來生產JavaDoc,學習一下如何自定義注釋模板。
. 自定義注釋模板
1. 通過 File –>Settings 或者 HotKey Ctrl + Alt + S 打開 Settings面板,如下圖
2. 點擊 Editor下的Live Templates。如下圖,顯示的是Android Studio為開發者提供的默認模板及快捷鍵。
3. 為了自定義注釋模板,點擊右上角的“+”,選擇Template Group創建一個自定義Template Group
4. 選擇創建好的Template Group, 在點擊“+”,選擇Live Template創建一個自定義的Template
5. 選擇創建好的Templat,如下圖。在Abbreviation內輸入字符串,例如decl。在Description內填寫描述信息。
6. 在點擊Template text輸入框下方的Define,選擇快捷鍵起作用的情況,選擇Declaration,在函數前面輸入decl后按回車即可以按模板生產注釋
7. 在Template text內輸入自定的注釋模板,$xxx$這類的變量可以通過Edit variables來設置其含義
8. 如果要生成JavaDoc,就要按規則書寫函數注釋模板,規則可以參考 Editor –> Code Style –>Java –>JavaDoc
9. 點擊Tools –>Generate JavaDoc 來生成Java Doc
10. 如果生產Java Doc失敗,檢查 Include jdk and library sources in –sourcepath是否勾選。
Other command line arguments,設置Android SDK的bootclasspath和編碼
1. -bootclasspath D:\AndroidSDK\sdk\platforms\android-23
2. -encoding utf-8
3. -charset utf-8