IDEA中设置给每个方法加上注释的快捷键

本篇博客为大家介绍如何自定义方法注释的快捷键

• 第一步
  
• 第二步
  
• 第四步
  
• Template Text：

*
 * @description: TODO 
 * @params: $param$
 * @return: $return$ 
 * @author: 你的名字，your name，自己更改
 * @dateTime: $date$ $time$
 */

• 这里注意了，格式就如上面所示，最上面的只有一个*号，没有/**
• 第五步
  
• 第六步
  
• 最后点击Apply==》OK即可完成

接下来说这个快捷键如何使用，好多人使用不恰当，最后达不到应有的效果，效果如下图所示：

• 使用方法
  • 这里首先大家看第四步的快捷键的名称是什么
    • 如果和我一样的是* 那么就是在方法上输入/** + Tab键即可出现如上效果，这也是在第四步的Template Text下面强调的格式，否则注释开头的样子就是/*/**，如下图。
      
    • 这里注意如果只输入* + Tab键的话就会出现如下效果
      
    • 一：会出现注释缺失的报错的问题，
    • 二：传入的参数和返回值为空的问题

#########################此处一下可以暂时不用看################################

• 这里做错误示范，先不管注释符号缺失的问题，如何解决使用* + Tab键生成的注释有参数和返回值
• 当在方法内使用* + Tab键就可以获取到方法的参数和返回值了，如下图所示。
  
  • 如上图所示，在方法内使用就可以获取到方法的参数和返回值了。

######################以上内容可以不看，与正常步骤无关########################

所以正常使用注释快捷键的方式是/*+你设置快捷键的名称 + Tab键就可以在方法上面添加正常的注释了。