一,Android Studio新建類頭部注釋
是不是有時候看到這個很心煩
其實Studio中有設置修改這些注釋模板的信息的功能
其實很簡單,只需要兩步:
1.打開Setting設置面板,找到File and Code Templates,選擇Includes下的File Header
2.修改成自己需要的變量名即可
二,Android Studio添加函數注釋模板及快捷鍵
1,javaDoc自動生成注釋
如果我們想獲取到方法名,參數返回值的信息,想讓這些信息全部自動生成的注釋里面的話,我們可以借助插件JavaDoc實現,安裝插件javaDoc 安裝完之后重啟studio
安裝JavaDoc插件
File → Settings → Plugins → Browse repositories 然后搜索Javadoc,然后點擊install並重啟androidstudio就ok了。
當在函數的前面輸入“/**”按回車鍵,就會補全整個注釋
- /**
- * @param a
- * @param b
- * @return
- */
- public int getSum(int a,int b){
- return a;
- }
設置函數注釋的快捷鍵:
1,打開Settings對話框,執行“File”-“Settings”,在左側選擇“Keymap”。
2,在快捷鍵搜索框中輸入“doc comment”,搜索注釋的快捷鍵,如圖:可以看到注釋的快捷鍵"Fix doc comment"沒有設置。
3,接下來,設置快捷鍵。,右鍵"Fix doc comment"項,選擇“Add Keyboard Shortcut“添加鍵盤類型的快捷,Enter Keyboard Shortcut對話框中,直接按想要設置的快捷鍵。設置為”Ctrl +Alt + 1“,可以看到該快捷鍵沒有沖突,並點擊”OK“按鈕完成快捷鍵設置,如圖:
把光標定位到想要添加注釋的函數里面,再按注釋的快捷鍵就會自動添加函數注釋了,如圖:
2,增加函數注釋模板,使用一個快捷鍵就可以出來,但是沒有前面的參數和返回值
Android Studio默認函數注釋為
- /**
- *
- */
下面方法將要改為如下格式
- /**
- *
- * @author zony
- * @time 15-11-25 下午2:41
- */
步驟如下:
一、File->Setting->Editor->Live Templates
二、點擊最右邊+,創建一個Template Group
三、填寫group名,任意填寫
四、選中你剛剛創建的group,創建Live Template
五、填寫Abbreviation,方便輸入和記憶可輸入doc,即這個注釋的快捷方式,在函數體上方輸入doc加回車即可
六、輸入注釋模板,Template text注釋模板,可參考eclipse模板,我的模板如下
七、設置doc快捷鍵生效位置:在聲明的時候生效,即你在函數名上面輸入doc加回車
八、關鍵一點,此步不對的話date和author不會生效
對定義的四個變量desc、user、date、time進行賦值,點擊Edit variables,按照如下圖設置變量
九、見成效的時刻,在函數名上輸入doc然后回車即可