IDEA類和方法注釋模板設(shè)置全過(guò)程
一直在使用idea自帶的注釋模板，但是一直不太好用，最近在網(wǎng)上整理了一些比較完整的模板使用方法，來(lái)供大家學(xué)習(xí)使用，有不對(duì)的地方，歡迎大家在下方留言。
idea和eclipse的注釋模板還是有一些差別的，下面就為大家介紹我整理的資料。
類注釋模板：
/**
* @program: ${PROJECT_NAME}
* @ClassName ${NAME}
* @description:
* @author: lyy
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
* @Version 1.0
**/
public class ${NAME} {
}
方法模板注釋：
/** @Author lyy * @Description //TODO $end$ * @Date $time$ $date$ * @Param $param$ * @return $return$ **/
一、類注釋
操作： File -> Settings - > Editor -> File and Code Templates -> Files -> Class
在右邊的文件框里編輯需要注釋的模板，應(yīng)用保存之后,當(dāng)我們創(chuàng)建類的時(shí)候就會(huì)自動(dòng)生成注釋。
類注釋模板：
/**
* @program: ${PROJECT_NAME}
* @ClassName ${NAME}
* @description:
* @author: lyy
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
* @Version 1.0
**/
public class ${NAME} {
}
1、如果要設(shè)置接口的，可以選擇Interface文件
2、$ {PROJECT_NAME}：項(xiàng)目名，自動(dòng)獲取我們創(chuàng)建的項(xiàng)目名.
3、$ {NAME}：設(shè)置類名，與下面的$ {NAME}一樣才能獲取到創(chuàng)建的類名
4、TODO：代辦事項(xiàng)的標(biāo)記，一般生成類或方法都需要添加描述
5、$ {USER}：設(shè)置創(chuàng)建類的用戶、創(chuàng)建的日期和時(shí)間，這些是IDEA內(nèi)置的方法
6、$ {YEAR}-$ {MONTH}-$ {DAY} $ {HOUR} $ {MINUTE}：創(chuàng)建的日期和時(shí)間
7、@Version 1.0：設(shè)置版本號(hào)，一般新創(chuàng)建的類都是1.0版本
效果展示（當(dāng)我們創(chuàng)建一個(gè)新類時(shí)，會(huì)自動(dòng)添加注釋）：
二、方法注釋模板
方法模板注釋：
/** @Author lyy * @Description //TODO $end$ * @Date $time$ $date$ * @Param $param$ * @return $return$ **/
操作： File -> Settings - > Editor -> Live Templates -> 點(diǎn)擊"+"號(hào) -> 選擇 Template Group
2.1 新建組名
2.2 添加注釋模板
2.3 點(diǎn)擊 Define
2.4 選擇 Everywhere ，這里我們選擇java就行了
如果修改過(guò)，則顯示為change而不是define
2.5 點(diǎn)擊右下角的Edit variables
PS:2.4和2.5順序不可顛倒，否則2.5將獲取不到方法
2.6 效果圖
注意使用方法注釋需要在 方法內(nèi) 進(jìn)行，否則會(huì)顯示Null
先寫方法然后在方法上，輸入"add"，按住tab注釋就會(huì)自己出來(lái)了，大功告成！
總結(jié)
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
SpringMVC中Controller層獲取前端請(qǐng)求參數(shù)的方式匯總
這篇文章主要介紹了SpringMVC中Controller層獲取前端請(qǐng)求參數(shù)的幾種方式,本文通過(guò)示例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2023-08-08
在工作中,經(jīng)常性的會(huì)出現(xiàn)在兩張表中查找相同ID的數(shù)據(jù),許多開(kāi)發(fā)者會(huì)使用兩層for循環(huán)嵌套,本文主要介紹了Java雙重for循環(huán)的優(yōu)化示例,感興趣的可以了解一下2025-06-06
這篇文章主要介紹了java 如何讀取遠(yuǎn)程主機(jī)文件的操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2021-02-02
這篇文章主要為大家詳細(xì)介紹了java控制臺(tái)打印本月的日歷，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2019-12-12
這篇文章主要介紹了Java高階語(yǔ)法Volatile，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-03-03
Java樂(lè)觀鎖防止數(shù)據(jù)沖突的詳細(xì)過(guò)程
樂(lè)觀鎖是一種并發(fā)控制機(jī)制,用于防止多個(gè)事務(wù)同時(shí)修改同一數(shù)據(jù)導(dǎo)致的數(shù)據(jù)不一致問(wèn)題,它通過(guò)在數(shù)據(jù)記錄中添加一個(gè)版本號(hào)或時(shí)間戳字段,來(lái)判斷數(shù)據(jù)在兩次操作之間是否被其他事務(wù)修改本文介紹了樂(lè)觀鎖防止數(shù)據(jù)沖突的詳細(xì)過(guò)程2025-04-04
SpringBoot手動(dòng)開(kāi)啟事務(wù):DataSourceTransactionManager問(wèn)題
這篇文章主要介紹了SpringBoot手動(dòng)開(kāi)啟事務(wù):DataSourceTransactionManager問(wèn)題，具有很好的價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2023-07-07
設(shè)計(jì)模式之構(gòu)建(Builder)模式 建造房子實(shí)例分析
構(gòu)建模式主要用來(lái)針對(duì)復(fù)雜產(chǎn)品生產(chǎn)，分離部件構(gòu)建細(xì)節(jié)，以達(dá)到良好的伸縮性,考慮到設(shè)計(jì)模式來(lái)源于建筑學(xué),因此舉一個(gè)建造房子的例子,需要的朋友可以參考下2012-12-12
在Java中處理異常并不是一個(gè)簡(jiǎn)單的事情,不僅僅初學(xué)者很難理解,即使一些有經(jīng)驗(yàn)的開(kāi)發(fā)者也需要花費(fèi)很多時(shí)間,本文為大家整理了java處理異常Exception的一些常用方法,希望對(duì)大家有所幫助2023-09-09
關(guān)于泛型擦除問(wèn)題的解決--Mybatis查詢類型轉(zhuǎn)換
這篇文章主要介紹了關(guān)于泛型擦除問(wèn)題的解決--Mybatis查詢類型轉(zhuǎn)換方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2022-08-08