idea 方法注释的快捷键设置

前言:

使用idea有过一段一段时间了,每次写完方法需要都需要注释,要么手动注释要么用快捷键(/** 回车)默认模板注释,不符合项目规定的注释要求,于是想了想是不是设置自定义的注释模板,上网查了资料整理一篇心得分享给大家。

正文:

默认注释是的样子:

  /**
     *
     * @param bookType
     * @param pageNum
     * @param pageSize
     * @return
     */
    public PaginationEntity getBookByType(String bookType, int pageNum, int pageSize) {...}

我们注释要求的样子:

    /**
     * @Description: 根据图书配型查询图书,工具类假分页。参数:图书类型,页码,每页图书数
     * @Param: [bookType, pageNum, pageSize]
     * @return: com.dmsdbj.library.controller.util.PaginationEntity
     * @Author: 姜晶
     * @Date: 2018/6/21
     */
    public PaginationEntity getBookByType(String bookType, int pageNum, int pageSize) {...}

具体实现步骤:

1、打开系统设置Setting(Ctrl+Alt+S快捷键)

2、Editor—>Live Templates—>点击+号。添加一个templates group来放置自己快捷键,效果图如下:

3、选中创建的group—>再次点击+号,添加一个Live template

idea 方法注释的快捷键设置_第1张图片

4、设置自定义的快捷键模板:

Abbreviation:快捷键,Description:描述该快捷键

Template text:自定义的快捷键模板

** 
* @Description: $description$ 
* @Param: $params$ 
* @return: $returns$ 
* @Author: 姜晶
* @Date: $date$ 
*/ 

效果图:

idea 方法注释的快捷键设置_第2张图片

5、设置注释的关联变量:先设置好Template text内容后—>Edit variables,变量如效果图设置就好。效果图:

idea 方法注释的快捷键设置_第3张图片

注意:注意:注意:设置完应用一下(Aplay)

应用的时候直接在方法前边写:/+快捷键名+Tab键。即可,比如我设置的快捷键方法名是a,效果图便是:

idea 方法注释的快捷键设置_第4张图片

结论:不将就是发现的源动力,在碰到繁琐的事情面前,不是将它分解处理,就是要想一个方法简化他。


你可能感兴趣的:(+-+-开发笔记-+-+)