1. 程式人生 > >IDEA 為類和方法自動生成註釋

IDEA 為類和方法自動生成註釋

一、新增類註釋:

(1)、方法一:

如圖,在類註釋中可以應用相關變數,這樣新建一個類時就能生成指定的註釋。

效果圖

(2)、方法二:

如圖也可以使用上圖方式給類加上註釋,與第一種不同的是,這種方式在建立類時會彈出提示框輸入 discription 。

效果圖

類註釋模板:


	/*
	 * @author:CG
	 * @date:${YEAR}/${MONTH}/${DAY} ${TIME}
	 * @discription:${discription}
	 */

二、新增方法註釋:

第一步:

第二步:

  1. 模板名 (後面再介紹其作用)
  2. 當前模板的描述資訊。
  3. 模板,其中可以引用一些變數。
  4. 設定變數引數,就是設定步驟 3 中的變數值。
  5. 快捷鍵,以哪種快捷鍵生成註釋,IDEA 預設是 Tab 鍵,可以改為其他,後面介紹。
  6. 設定模板應用場景。

在 IDEA 中生成註釋的方式是 /* + 模板名 + 快捷鍵,我這兒就是 /* + * +Tab ,如果你的模板名為 note ,那麼你生成註釋的方法是 /* + note + Tab.

註釋模板:


	*
	 * @author: CG
	 * @description: $description$
	 * @param: $params$
	 * @date: $date$
	 * @time: $time$
	 * @return: $return$
	 */

因為在生成註釋時,已經輸入了 ’ /* ’ 所以模板前面不需要 ’ / ’ 了。

設定變數:

點選 4 中的按鈕,進入上圖提示框,初始為空,按照引數名字,找到對應的表示式即可,這樣在生成註釋時,就能自動獲取到對應引數的值。

設定快捷鍵:

點選 5 中的下拉框,如圖:

選擇自己喜歡的快捷鍵方式,預設是 Tab 鍵。

設定應用場景:

點選 6 中的 Define (如果曾經修改過,則顯示為Change而不是Define):

選擇 Everywhere.

完成以上操作,就可以使用對用的方式生成註釋了。

第三步:

在方法上面,輸入設定的生成模板方法:

如果註釋上的變數值都能正確的獲取,就設定表明成功了。