閱讀目錄:
閱讀正文:
1、爲類添加自動註釋模版
File-->Settings-->Editor-->File and Code Templates
/**
* @ Author :mmzs.
* @ Date :Created in ${TIME} ${DATE}
* @ Description:${description}
* @ Modified By:
* @Version: $version$
*/
此時,當你創建新的類時,就會自動生成註釋了。
2、爲方法添加自動註釋模版
File-->Settings-->Editor-->Live Templates
點擊"+"號後,選擇"Templates Group…"
/**
* create by: mmzs
* description:$description$
* create time: $time$ $date$
*
$params$
* @return $return$
*/
params的Exception內容如下:
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @'+'Param: ' + params[i] + ((i < params.size() - 1) ? '\\n'+'\\b' : '')}; return result", methodParameters())
點擊Ok。
此時,在方法體內部輸入add+Tab就可以生成註釋了。
Intellij Idea自動添加註釋的方法
2017.08.20 21:22* 字數 914 閱讀 2741評論 0喜歡 6
程序媛阿歷終於要寫第一篇關於開發的文章了!!!
阿歷用Intellij Idea開發,版本是Ultimate 2017.2.2。這周寫代碼的時候,發現編輯註釋很麻煩,不但要寫註釋符,還要寫名字、日期、描述等等,很繁瑣。工具是用來提高效率的,爲了提高開發的效率,我去網上搜索了Intellij Idea自動添加註釋的方法。因爲現有總結不夠全面,而且有的方法對於我的版本不太奏效,於是我整理了自動添加註釋的方法(很抱歉忘記記錄參考的網址了),親測有效。
自動添加註釋有兩類方法:1、創建文件時,idea自動生成註釋;2、在編輯源文件時,插入註釋。下面具體介紹。
1、創建文件時,idea自動生成註釋
第一種很簡單,一張圖就可以說清楚。過程是,在設置中找到“File and Code Templates”,在類文件的模板中添加註釋。具體如下圖(圖1)所示:
(1)首先打開設置,點File,Settings即可打開下圖界面,或者直接用快捷鍵“Ctrl+Alt+S”(我特別喜歡用快捷鍵^^)打開設計界面。
(2)在搜索框中輸入“File and Code Templates”,打開“File and Code Templates”。
(3)在右側的Files一欄中,找到Class,編輯註釋。下面的Description介紹了可以使用的系統變量,按需索取。
(4)最後點擊Apply和OK就完成啦。
圖1 新建文件,自動生成註釋
至此,你可以新建一個class文件,測試一下啦!
2、在編輯源文件時,插入註釋
這個步驟有點多,但是同樣很簡單。大致過程是打開“Live Templates”,新建我們自己的template,編輯註釋文本,定義應用文件,編輯變量。具體看下面:
(1)打開Settings,找到“Live Templates”,點右側“+”,新建一個“Template Group...”,見圖2.1、2.2。
圖2.1 新建Template Group
圖2.2 輸入Group名字
(2)選中剛建好的Group,再點右側“+”,創建一個“Live Template”,見圖2.3。
圖2.3 新建Live Template
(3)編輯Template的縮寫(插入註釋時用),在Template text中編輯註釋模板(如圖2.4)。注意變量的定義方式,用兩個$包圍變量名,例如變量user的定義爲$user$。
(4)定義應用這個Template的環境,點擊Define。我選擇了Java(如圖2.5)。
圖2.4 編輯註釋
圖2.5 選擇應用場景
(5)編輯變量,點擊“Edit variables”,如圖2.6、2.7。給變量選擇表達式或者定義默認值。
圖2.6 編輯變量
圖2.7 選擇表達式或設置默認值
(6)最後點擊“Apply”和“OK”(圖),就完成啦。
圖2.8 完成設置
試試這個方法吧(圖2.9、2.10):在class源文件編輯器中,輸入步驟(3)設置的模板縮寫,例如我設置的是“cmmt”。Idea會顯示提示,然後回車,就插入註釋了。
圖2.9 測試
圖2.10 效果
結語:
成功設置了自動添加註釋,感覺還是很神奇的,佩服開發工具的工程師。
雖然研究設置花費一定的時間,但是成功之後用得就很爽了,簡直是一勞永逸!
以後會盡量多寫跟技術相關的文章~~畢竟是個程序媛,哈哈。加油!
希望本文對你有幫助。