idea为类和方法自动生成注释

文章目录

  • 问题
  • 解决
    • 为方法自动增加注释
    • 为类自动增加注释

问题

创建类和方法的时候能否自动生成注释呢?
解释返回的数据,以及传入的数据等等

解决

为方法自动增加注释

先创建一个模板组,用来管理自己定义的模板

idea为类和方法自动生成注释_第1张图片

然后新建一个模板,注意命名,假如命名为show
idea为类和方法自动生成注释_第2张图片
代码

**
 * @Author li
 * @Description //TODO $end$
 * @Date $time$ $date$
 * @Param $param$
 * @return $return$
 **/

配置作用域,如果之前没有创建过显示为创建而不是改变,一般选择everwhere
这里只选择java

idea为类和方法自动生成注释_第3张图片
idea为类和方法自动生成注释_第4张图片
配置参数的获得
idea为类和方法自动生成注释_第5张图片
如图
idea为类和方法自动生成注释_第6张图片
确认
那么当你在方法上输入/+show时会自动提示添加模板
idea为类和方法自动生成注释_第7张图片
idea为类和方法自动生成注释_第8张图片

为类自动增加注释

当创建类的时候自动为类增加注释
idea为类和方法自动生成注释_第9张图片
如图所示,不仅是类,也可以是接口等等,这是改变了idea本身内置的模板代码,和为方法添加注释不同。这个不需要调用快捷键,创建类时自动添加
代码

/**
    *@ClassName ${
     NAME}
    *Description TODO
    *@Author ${
     USER}
    *@Date ${
     DATE} ${
     TIME}
    *@Version 1.1
**/

你可能感兴趣的:(javaweb,java)