1. 程式人生 > 其它 >IDEA給【類】和【方法】設定作者和日期等註釋

IDEA給【類】和【方法】設定作者和日期等註釋

https://blog.csdn.net/m0_61933976/article/details/127021176

一、在Java類的開頭自動註釋作者名字和日期等資訊

這樣以後只要我們建立一個類,就會自動顯示作者名和日期時間等資訊,便於記錄!

第一步:開啟模板(FIle and Code Templates)。(位置如下:File--->Settings--->Editor--->Code Style--->File and Code Templates)。

 第二步,選擇File Header,進行註釋資訊的設定。

常用的預設變數有:

變數 說明
${PACKAGE_NAME} 包名
${PROJECT_NAME} 專案名
${FILE_NAME} 檔名
${NAME} 新檔案的名稱
${USER} 登入使用者名稱
${DATE} 系統時間
${TIME} 系統時間
${YEAR}
${MONTH}
${DAY}
${HOUR}
${MINUTE}

 我們不妨寫一個簡單的註釋

/**
*@Author:朗朗乾坤
*@Package:${PACKAGE_NAME}
*@Project:${PROJECT_NAME}
*@name:${NAME}
*@Date:${DATE}  ${TIME}
*@Filename:${NAME}
*/

把註釋資訊直接拷貝過去。

 這樣我們以後每次建立一個類,就會自動生成註釋資訊,效果展示:

二、在Java的方法註釋作者名字和日期等資訊

在 IDEA 中,Postfix Completion有很多內建的編碼模板,使用者只需要敲擊簡單的字首即可生成程式碼;但是這些模板是固定的無法改變。鑑於 Postfix Completion 模板無法改變,IDEA 提供了 Live Templates 模板,該模板使用者可以自定義。

可修改模板(File--->Settings--->Editor--->Code Style--->Live Templates),裡面有很多內建可修改的模板;我們可以進行修改已有的模板,也可以建立一個屬於自己的模板。

 我可以建立一個註釋模板,定義一個快捷鍵。這樣我們只要按下快捷鍵就可以完成模板定義。 

第一步:建立一個模板組:myTemplates。

 第二步:建立模板:mdes。

 在自定義模板中,可以通過 $名稱$ 的形式宣告變數,然後使用 內建的函式 為變數動態的賦值。

/**
*@Date:$date$  // date變數下面會用內建函式進行賦值
*@Author:
*@return:
*
*/

 第三步:點選Edit variables,使用 內建的函式date()為date變數動態的賦值。

 第四步:點選最下面的Define,設定模板的生效範圍,分不清楚的話直接選Everywhere即可。

 第五步:這樣以後給方法註釋,先打出m就會有提示:

 然後回車就會自動生成註釋資訊: