idea生成類注釋和方法注釋的正確方法


			轉自					https://blog.csdn.net/qq_34581118/article/details/78409782				</div>
							            <div id="content_views" class="markdown_views">
						<!-- flowchart 箭頭圖標 勿刪 -->
						<svg xmlns="http://www.w3.org/2000/svg" style="display: none;"><path stroke-linecap="round" d="M5,0 0,2.5 5,5z" id="raphael-marker-block" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></path></svg>
						<h1 id="目錄"><a name="t0"></a>目錄</h1>

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

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

   
   
  
  
          
  • 1

生成類注釋

  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什么都是里面的,大家可以自行百度一下學習一下。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM