一直在使用idea自帶的註釋模板,但是一直不太好用,最近在網上整理了一些比較完整的模板使用方法,來供大家學習使用,有不對的地方,歡迎大家在下方留言。
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
在右邊的文件框裏編輯需要註釋的模板,應用保存之後,當我們創建類的時候就會自動生成註釋。
類註釋模板:
/**
* @program: ${PROJECT_NAME}
* @ClassName ${NAME}
* @description:
* @author: lyy
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
* @Version 1.0
**/
public class ${NAME} {
}
1、如果要設置接口的,可以選擇Interface文件
2、$ {PROJECT_NAME}:項目名,自動獲取我們創建的項目名.
3、$ {NAME}:設置類名,與下面的$ {NAME}一樣才能獲取到創建的類名
4、TODO:代辦事項的標記,一般生成類或方法都需要添加描述
5、$ {USER}:設置創建類的用戶、創建的日期和時間,這些是IDEA內置的方法
6、$ {YEAR}-$ {MONTH}-$ {DAY} $ {HOUR} $ {MINUTE}:創建的日期和時間
7、@Version 1.0:設置版本號,一般新創建的類都是1.0版本
效果展示(當我們創建一個新類時,會自動添加註釋):
二、方法註釋模板
方法模板註釋:
/** @Author lyy
* @Description //TODO $end$
* @Date $time$ $date$
* @Param $param$
* @return $return$
**/
操作: File -> Settings - > Editor -> Live Templates -> 點擊"+"號 -> 選擇 Template Group
2.1:新建組名:
2.2 添加註釋模板:
2.3 點擊 Define:
2.4 選擇 Everywhere ,這裏我們選擇java就行了
如果修改過,則顯示爲change而不是define
2.5 點擊右下角的Edit variables
PS:2.4和2.5順序不可顛倒,否則2.5將獲取不到方法
2.6 效果圖:
注意使用方法註釋需要在 方法內 進行,否則會顯示Null
先寫方法然後在方法上,輸入"add",按住tab註釋就會自己出來了,大功告成!有不懂得小夥伴記得留言,小農看見了會第一時間回覆大家