IDEA類和方法注釋模板設(shè)置(非常詳細)
idea 模版之自定義類與方法注釋
很多公司都有要求的代碼注釋規(guī)范,我們每新建類或者方法的時候從新復(fù)制粘貼很麻煩,而且容易粘錯。
當然自定義模板還可以用到很多地方,比如系統(tǒng)自帶的 sout就是system.out.print(); 當你輸入某文本的時候,系統(tǒng)會自動替換成目標文本。
1定義java文件頭部的注釋
2給java類中的方法添加上注釋
2.1第一步勾選Enable Live Templates
2.2第二步新建一個Group
2.3第三步新建一個Template
2.4第四步點擊Define按鈕
2.5第五步填寫注釋模板
1、定義java文件頭部的注釋
打開設(shè)置面板,然后填寫注釋模板:
File => setting => editor => File and Code Templates
如圖:
2、給java類中的方法添加上注釋
2.1、第一步勾選Enable Live Templates
首先要在上一章節(jié)的圖中勾選中 Enable Live Templates
如圖:
2.2、第二步新建一個Group
其次要打開LiveTemplates 然后新建一個Group
如圖:
在彈窗口中輸入你想要的group名稱,例如我取名叫chenjieGroup
如圖:
點擊OK,你已經(jīng)新建了一個模板組,名稱叫chenjieGroup
如圖:
2.3、第三步新建一個Template
選中新建的group,也就是選中chenjieGroup,在這個group下新建一個LiveTemplate
如圖:
上圖中點擊Live Template之后,將會新建一個模板,并且光標定位到了需要你輸入快捷鍵的方框中
如圖:
我輸入了cjm意思是當我在java文件的某個方法內(nèi)部,連續(xù)輸入cjm后,intellij將會在該方法的頭上為我自動生成注釋(根據(jù)我接下來定義的模板來生成)。
2.4、第四步點擊Define按鈕
點擊上圖中的Ok按鈕左上方的define
如圖:
在彈出的下拉框內(nèi)選擇作用域,這里選擇java文件
如圖:
2.5、第五步填寫注釋模板
在第四步完成后,Templatetext框內(nèi)的內(nèi)容可以編輯了,在Template text 內(nèi)寫入模板,例如我敲入的模板是:
/** *@描述 *@參數(shù) $params$ *@返回值 $return$ *@創(chuàng)建人 chenjie *@創(chuàng)建時間 $date$ *@修改人和其它信息 */
如圖:
說明:在此步驟中,模板內(nèi)容你可以自己寫,兩個$號內(nèi)部是參數(shù)名稱,都有哪些參數(shù)呢,你可以點擊Editvariables,然后在彈窗口中自己查看和選擇
點擊Edit variables會彈出框
如圖:
彈出框
如圖:
上圖中,Name這一列是你可以設(shè)置的參數(shù)名稱,Expression這一列是你可以選擇的表達式,點擊Expression這一列的單元格,即可出現(xiàn)下拉框
如圖:
例如我依次給params、return、date這三個變量設(shè)置了表達式
如圖:
點擊OK(兩個窗口上的OK都要點擊)
好了,現(xiàn)在可以驗證了。
新建一個Utils類
如圖:
取名Utils
如圖:
可以看到,文件頭部的注釋已經(jīng)有了
如圖:
新建一個方法,內(nèi)容如下:
public static String sayHello(String userName) { return "hello "+userName; }
如圖:
在上圖畫紅框的地方輸入我們剛才設(shè)置的快捷鍵cmj即可看到intellij給我們添加的注釋
如圖:
快捷鍵需要在方法內(nèi)部,也就是花括號內(nèi)部,至于是不是在紅框的位置都可以,例如在return語句的后面或者其他地方也可以,只要是在sayHello方法內(nèi)部即可。我輸入cjm然后就可以得到提示
如圖:
好了,敲回車后,intellij將我輸入的cjm替換為了方法的注釋(根據(jù)我們上一步設(shè)置的模板來生成注釋)
如圖:
說明:此時有點2,還需要自己把注釋剪切到方法外部去,不過總比我們手動敲注釋好多了??旖萱I可以在方法外部敲,也可以生成注釋,但是參數(shù)和返回值就沒法給你生成了,因為參數(shù)和返回的值只有在函數(shù)作用域內(nèi),intellij才能找到,所以快捷鍵最好還是在方法內(nèi)部敲,我剛才的cjm就是在方法內(nèi)部敲的。
以上就是本文的全部內(nèi)容,希望對大家的學習有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
java控制臺實現(xiàn)學生信息管理系統(tǒng)(IO版)
這篇文章主要為大家詳細介紹了java控制臺實現(xiàn)學生信息管理系統(tǒng)(IO版),文中示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下2021-04-04Spring AOP實現(xiàn)復(fù)雜的日志記錄操作(自定義注解)
Spring AOP實現(xiàn)復(fù)雜的日志記錄操作(自定義注解),具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-09-09idea2019.2安裝MybatisCodeHelper插件的超詳細教程
這篇文章主要介紹了idea2019.2安裝MybatisCodeHelper插件的教程,本文給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-09-09Java中OkHttp 超時設(shè)置的實現(xiàn)
超時設(shè)置是網(wǎng)絡(luò)編程中不可忽視的一部分,本文就來介紹一下Java中OkHttp 超時設(shè)置的實現(xiàn),具有一定的參考價值,感興趣的可以了解一下2024-06-06使用Springboot根據(jù)配置文件動態(tài)注入接口實現(xiàn)類
這篇文章主要介紹了使用Springboot根據(jù)配置文件動態(tài)注入接口實現(xiàn)類,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-08-08