1. 程式人生 > >IDEA配置註釋模板(類和方法)

IDEA配置註釋模板(類和方法)

背景

程式碼程式設計規範:註釋,註釋,方便後來者的程式碼閱讀和責任出處

IDEA類註釋模板配置

1、開啟File-->Settings-->Editor-->File and Code Templates,選擇Includes下面的File Header

註釋模板:

/**
 * @Description: TODO
 * @author: ${USER}
 * @date: ${DATE} ${TIME}
 */

 

提示:此處註釋模板裡面獲取變數值的格式必須是 ${ 變數值 },變數必須大寫,否則獲取不到,在此處設定註釋模板後,當你新建java類的時候會自動生成註釋。

效果:

2、對於個別公司來說,編寫的程式碼都會帶有自己的版權宣告,此處來講解版權宣告的配置

模板:

/**
 * ${NAME}.java
 * ${PACKAGE_NAME}
 * Copyright (c) ${YEAR}, 北京XXXX科技有限公司版權所有.
*/

 

注:此處獲取變數的格式和上述相同

效果:

方法註釋

1、開啟File-->Settings-->Editor-->Live Templates,點選右上角的 + 號,選擇Template Group

2、建立分組這裡可以按照個人愛好起名稱

3、選中建立組,點選右上角 + 號,選擇Live Template

4、建立註釋方法

註釋模板:

/**
 * @Function: TODO
 * @author: 使用者名稱稱
 * @Date: $date$ $time$
 * @param: $param$
 * @return: $return$
 */

 

5、選擇註釋的檔案型別

6、設定註釋引數型別

效果:

提醒:此處的註釋模板獲取引數的格式:$引數名$,如:$return$,否則獲取不到