idea生成類註釋和方法註釋的正確方法

目錄
目錄
生成類註釋
生成類註解模板
生成方法註釋
生成方法註解模板
最近從eclipse轉idea了,第一步固然是配置快捷鍵,模板等。可是!發生了一件賊蛋疼的事情,居然一直找不到正確添加方法註釋的方法! 最後本身摸索到了,在此詳細記錄,供你們參考。eclipse

測試版本爲idea for mac,可能快捷鍵不一樣,可是設置等確定是相同的
1
生成類註釋
打開Preferences
Editor -> File and Code Templates -> Files -> Class ide


效果圖 學習

網上不少都是在Includes的File Header裏面添加,在這裏面添加還須要本身去移動下鼠標,而後再去操做鍵盤,再去寫description,,直接在建立類的時候就添加好description不更快嗎?測試

在此添加的話你每次建立類的時候會彈兩次框,第二次是讓你輸入description的內容了,so, 這就是最優的方法
同理,也能夠在這兒爲你的Interface,Enum添加上註釋idea

生成類註解模板
/**
* @program: ${PROJECT_NAME}
*
* @description: ${description}
*
* @author: Mr.Wang
*
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/
這裏的代碼區顯示有問題,csdn有bug ,去掉裏面的中文就好了。.net

生成方法註釋
打開Preferences
Editor -> Live Templates -> 點擊右邊加號爲本身添加一個Templates Group -> 而後選中本身的Group再次點擊加號添加Live Templates blog

而後設置本身喜歡的快捷鍵 在Abbreviation裏面 記得在Applicable in 裏面勾選,起碼也要勾選class ip

这里写图片描述

而後在Edit variables裏面添加參數和返回值的自動取值 get

Expression裏面選擇就是了 it


而後再你的方法上面直接輸入/ + 你設置的Abbreviation快捷鍵 + tab鍵就直接生成了 (我設置的是/+ a + tab) 
效果圖: 

裏面的參數和返回值都是根據你在Edit variables裏面添加的自動生成的,

生成方法註解模板

** 
* @Description: $description$ 
* @Param: $params$ 
* @return: $returns$ 
* @Author: Mr.Wang 
* @Date: $date$ 
*/ 

注意,這個和類註解模板有點不同,這個是用兩個$$ ,這個的做用就是生成後光標直接跳到當前位置,這樣也能夠直接去輸入description的內容了

相關文章
相關標籤/搜索