IDEA註釋詳解

目錄

最近從eclipse轉idea了,第一步當然是配置快捷鍵,模板等。但是!發生了一件賊蛋疼的事情,竟然一直找不到正確添加方法註釋的方法! 最後自己摸索到了,在此詳細記錄,供大家參考。

測試版本爲idea for mac,可能快捷鍵不同,但是設置等肯定是相同的
  • 1
  • 2

生成類註釋

  1. 打開Preferences
  2. Editor -> File and Code Templates -> Files -> Class 
    這裏寫圖片描述

  3. 效果圖 
    這裏寫圖片描述
    網上很多都是在Includes的File Header裏面添加,在這裏面添加還需要自己去移動下鼠標,然後再去操作鍵盤,再去寫description,,直接在創建類的時候就添加好description不更快嗎?

    • 在此添加的話你每次創建類的時候會彈兩次框,第二次是讓你輸入description的內容了,so, 這就是最優的方法
  4. 同理,也可以在這兒爲你的Interface,Enum添加上註釋

生成類註解模板

/**
* @program: ${PROJECT_NAME}
*
* @description: ${description}
*
* @author: Mr.Wang
*
* @create: ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
**/
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9

這裏的代碼區顯示有問題,csdn有bug ,去掉裏面的中文就行了。


生成方法註釋

  1. 打開Preferences
  2. Editor -> Live Templates -> 點擊右邊加號爲自己添加一個Templates Group -> 然後選中自己的Group再次點擊加號添加Live Templates 
    這裏寫圖片描述
    這裏寫圖片描述
  3. 然後設置自己喜歡的快捷鍵 在Abbreviation裏面 記得在Applicable in 裏面勾選,起碼也要勾選class 
    這裏寫圖片描述
  4. 然後在Edit variables裏面添加參數和返回值的自動取值 
    這裏寫圖片描述
    Expression裏面選擇就是了 
    這裏寫圖片描述

  5. 然後再你的方法上面直接輸入/ + 你設置的Abbreviation快捷鍵 + tab鍵就直接生成了 (我設置的是/+ a + tab) 
    效果圖: 
    這裏寫圖片描述
    裏面的參數和返回值都是根據你在Edit variables裏面添加的自動生成的,

生成方法註解模板


** 
* @Description: $description$ 
* @Param: $params$ 
* @return: $returns$ 
* @Author: Mr.Wang 
* @Date: $date$ 
*/ 

注意,這個和類註解模板有點不一樣,這個是用兩個$$ ,這個的作用就是生成後光標直接跳到當前位置,這樣也可以直接去輸入description的內容了

對於 Live Templates只能說真的很強大,你平常用的sout ,psvm什麼都是裏面的,大家可以自行百度一下學習一下。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章