IDEA為類和方法設(shè)置注解模板過程
更新時間：2026年04月23日 08:47:51 作者：鄉(xiāng)下小哥編程
本文主要講述了在IntelliJ IDEA中創(chuàng)建類和方法注解模板的步驟與實(shí)際效果,并提供了兩種方法注解模板的具體實(shí)現(xiàn)過程,通過自定義模板,用戶可以自動化地生成類和方法的注釋,提高開發(fā)效率
1、類方法注解模板
1、File–>settings–>Editor–>File and Code Templates–>Files
@BelongsProject：項(xiàng)目名@BelongsPackage：當(dāng)前包的名稱@Author：作者姓名@CreateTime：該類創(chuàng)建的時間@Description：對該類的描述@Version：設(shè)置版本號，一般新創(chuàng)建的類都是1.0版本，這里寫死就可以了
1.1 模板
將這部分代碼 放到IDEA 的指定位置。
/**
*@BelongsProject: ${PROJECT_NAME}
*@BelongsPackage: ${PACKAGE_NAME}
*@Author: zhengyuzhu
*@CreateTime: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
*@Description: TODO
*@Version: 1.0
*/
1.2 實(shí)際效果
編寫一個類，試一下
/**
* @BelongsProject: Java-Work-Demo
* @BelongsPackage: A1多線程.B1超時處理.Demo1
* @Author: zhengyuzhu
* @CreateTime: 2023-11-14 11:31
* @Description: TODO
* @Version: 1.0
*/
public class MyTest {
}
2、方法注解模板(一)
1.1 模板
* * @description: * @author: zhengyuzhu * @date: $date$ $time$ * @param: $param$ * @return: $return$ **/
實(shí)現(xiàn)的效果是這樣的
具體操作過程如下：
這里注意一點(diǎn)，這里的操作順序不要弄錯了。否則，函數(shù)方法可能會讀取不到。
1.2 實(shí)際效果
/**
* @description:
* @author: zhengyuzhu
* @date: 2023/11/14 12:21
* @param: [a, str]
* @return: void
**/
public void Test(int a, String str){
}
/**
* @description:
* @author: zhengyuzhu
* @date: 2023/11/14 12:22
* @param: []
* @return: java.util.List
**/
public List Test2(){
ArrayList<Object> list = new ArrayList<>();
return list;
}
3、方法注解模板(二)
1.1 模板
* * @description: * @author: zhengyuzhu * @date: $date$ $time$ $param$ $return$ **/
效果展示
具體實(shí)現(xiàn)過程，過程和 一 相似。只需要改變模板，和獲取方法就可以了。
具體過程如下：
自定義方法：參數(shù)獲取
groovyScript("def result = '';def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param: ' + params[i] + ((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? null : '\\r\\n ' + result", methodParameters())
自定義方法：返回值 包含包名
groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return: ' + \"${_1}\"", methodReturnType())
自定義方法： 返回值 不包含包名
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList(); for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';}; def p1=params[i].split(',').toList(); for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').toList(); result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','} } ; }; return result", methodReturnType())
1.2 實(shí)際效果
我習(xí)慣用返回值包含包名的、根據(jù)個人習(xí)慣來改。
/**
* @description:
* @author: zhengyuzhu
* @date: 2023/11/14 12:34
* @param: a
* @param: b
* @param: c
* @return: java.lang.String
**/
public String TestDemo(int a,String b,List c){
return null;
}
/**
* @description:
* @author: zhengyuzhu
* @date: 2023/11/14 12:41
* @param: a
* @param: b
* @return: java.util.List<java.lang.String>
**/
public List<String> list (int a ,String b){
return null;
}
總結(jié)
以上為個人經(jīng)驗(yàn)，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
Spring?Boot集成Milvus快速入門demo示例詳解
Milvus是一種高性能向量數(shù)據(jù)庫,支持從筆記本到大型分布式系統(tǒng)的多環(huán)境運(yùn)行,它以開源和云服務(wù)形式提供,是LFAI & Data Foundation的項(xiàng)目,采用Apache 2.0許可,Milvus特別支持高并行化和解耦的系統(tǒng)架構(gòu),使其能夠隨數(shù)據(jù)增長而擴(kuò)展,支持各種復(fù)雜搜索功能,滿足企業(yè)級AI應(yīng)用需求2024-09-09
本文主要介紹了Java實(shí)現(xiàn)可配置換膚的方法示例，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-06-06
Java 多線程核心組件關(guān)鍵特征對比與實(shí)戰(zhàn)指南
本文詳細(xì)對比了Java多線程核心組件,包括Runnable、Callable、Future、CompletableFuture、ExecutorService、CountDownLatch、CyclicBarrier、Semaphore和ConcurrentHashMap等,并提供了最佳實(shí)踐和性能優(yōu)化建議,感興趣的朋友跟隨小編一起看看吧2025-12-12
如何將DeepSeek 集成到 Java 的 Spring Boot&
本文介紹了如何將DeepSeek集成到Java的SpringBoot項(xiàng)目中,包括準(zhǔn)備工作、集成步驟和示例說明,感興趣的朋友一起看看吧2025-02-02
Java實(shí)現(xiàn)讀取CSV文件數(shù)據(jù)內(nèi)容(含逗號處理)
這篇文章主要為大家詳細(xì)介紹了如何使用Java實(shí)現(xiàn)讀取CSV文件數(shù)據(jù)內(nèi)容,包含了逗號處理,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2025-07-07
Java中Integer類常用靜態(tài)方法實(shí)例詳解
在Java編程中Integer類是int基本類型的封裝類,提供了許多方便的功能,這篇文章主要介紹了Java中Integer類常用靜態(tài)方法的相關(guān)資料,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下2025-07-07
SpringBoot高級配置之臨時屬性、配置文件、日志、多環(huán)境配置詳解
這篇文章主要介紹了SpringBoot高級配置之臨時屬性、配置文件、日志、多環(huán)境配置,本文結(jié)合實(shí)例代碼給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下2023-02-02
Java 利用枚舉實(shí)現(xiàn)接口進(jìn)行統(tǒng)一管理
這篇文章主要介紹了Java 利用枚舉實(shí)現(xiàn)接口進(jìn)行統(tǒng)一管理，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2021-02-02
java實(shí)現(xiàn)遠(yuǎn)程連接執(zhí)行命令行與上傳下載文件
這篇文章主要介紹了java實(shí)現(xiàn)遠(yuǎn)程連接執(zhí)行命令行與上傳下載文件方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-05-05
GateWay動態(tài)路由與負(fù)載均衡詳細(xì)介紹
這篇文章主要介紹了GateWay動態(tài)路由與負(fù)載均衡，GateWay支持自動從注冊中心中獲取服務(wù)列表并訪問，即所謂的動態(tài)路由2022-11-11