Intellij Idea自動添加注釋的方法

程序媛阿歷終于要寫第一篇關于開發的文章了!?。?/p>

阿歷用Intellij Idea開發,版本是Ultimate 2017.2.2。這周寫代碼的時候,發現編輯注釋很麻煩,不但要寫注釋符,還要寫名字、日期、描述等等,很繁瑣。工具是用來提高效率的,為了提高開發的效率,我去網上搜索了Intellij Idea自動添加注釋的方法。因為現有總結不夠全面,而且有的方法對于我的版本不太奏效,于是我整理了自動添加注釋的方法(很抱歉忘記記錄參考的網址了),親測有效。

自動添加注釋有兩類方法:1、創建文件時,idea自動生成注釋;2、在編輯源文件時,插入注釋。下面具體介紹。

1、創建文件時,idea自動生成注釋

第一種很簡單,一張圖就可以說清楚。過程是,在設置中找到“File and Code Templates”,在類文件的模板中添加注釋。具體如下圖(圖1)所示:

(1)首先打開設置,點File,Settings即可打開下圖界面,或者直接用快捷鍵“Ctrl+Alt+S”(我特別喜歡用快捷鍵^^)打開設計界面。

(2)在搜索框中輸入“File and Code Templates”,打開“File and Code Templates”。

(3)在右側的Files一欄中,找到Class,編輯注釋。下面的Description介紹了可以使用的系統變量,按需索取。

(4)最后點擊Apply和OK就完成啦。

圖1 新建文件,自動生成注釋

至此,你可以新建一個class文件,測試一下啦!

2、在編輯源文件時,插入注釋

這個步驟有點多,但是同樣很簡單。大致過程是打開“Live Templates”,新建我們自己的template,編輯注釋文本,定義應用文件,編輯變量。具體看下面:

(1)打開Settings,找到“Live Templates”,點右側“+”,新建一個“Template Group...”,見圖2.1、2.2。

圖2.1 新建Template Group
圖2.2 輸入Group名字

(2)選中剛建好的Group,再點右側“+”,創建一個“Live Template”,見圖2.3。

圖2.3 新建Live Template

(3)編輯Template的縮寫(插入注釋時用),在Template text中編輯注釋模板(如圖2.4)。注意變量的定義方式,用兩個$包圍變量名,例如變量user的定義為$user$。

(4)定義應用這個Template的環境,點擊Define。我選擇了Java(如圖2.5)。

圖2.4 編輯注釋
圖2.5 選擇應用場景

(5)編輯變量,點擊“Edit variables”,如圖2.6、2.7。給變量選擇表達式或者定義默認值。

圖2.6 編輯變量
圖2.7 選擇表達式或設置默認值

(6)最后點擊“Apply”和“OK”(圖),就完成啦。

圖2.8 完成設置

試試這個方法吧(圖2.9、2.10):在class源文件編輯器中,輸入步驟(3)設置的模板縮寫,例如我設置的是“cmmt”。Idea會顯示提示,然后回車,就插入注釋了。

圖2.9 測試
圖2.10 效果


結語:

成功設置了自動添加注釋,感覺還是很神奇的,佩服開發工具的工程師。

雖然研究設置花費一定的時間,但是成功之后用得就很爽了,簡直是一勞永逸!

以后會盡量多寫跟技術相關的文章~~畢竟是個程序媛,哈哈。加油!

希望本文對你有幫助。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,836評論 6 540
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,275評論 3 428
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 177,904評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,633評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,368評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,736評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,740評論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,919評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,481評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,235評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,427評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,968評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,656評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,055評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,348評論 1 294
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,160評論 3 398
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,380評論 2 379

推薦閱讀更多精彩內容