idea 类注释 和 方法注释 模板 制定

      在用idea写Java工程代码的时候,需要让idea自动生成一些重复性注释,这个我们可以通过设定模板的方式来进行设置。

类注释模板的设定

  • 位置选择
    1、Preferences ——> File and Code Templates ——> Includes里添加File Header模板
    idea 类注释 和 方法注释 模板 制定_第1张图片

  • 模板内容设定
    直接将下面代码拷贝到模板内容里面即可,当然也可以按照自己的需求进行更改:

/**
 * @author YourName
 * @project ${PROJECT_NAME}
 * @company YourCompanyName
 * @version 
 * @date ${TIME} ${DATE}
 * @class ${NAME}
 * @brief 
 */
  • 注意事项
    模板下面有一个Enable Live Templates 选项需要进行勾选,否则方法模板设置对应的的Live Templates 选项找不到。
    idea 类注释 和 方法注释 模板 制定_第2张图片

-效果展示
直接创建一个类后,即可有类模板的自动注释,版本信息及简介内容可以自己手动填入:
idea 类注释 和 方法注释 模板 制定_第3张图片

方法模板的设定

  • 位置选择
    1、Preferences ——> Live Templates ——>添加用户自定义模板
    idea 类注释 和 方法注释 模板 制定_第4张图片
    idea 类注释 和 方法注释 模板 制定_第5张图片
    2、模板命名&&模板描述&&快捷键设定
    可以命名为*,这样方面键入快速注释,添加模板描述信息,例如:add Commands for method,然后设定快捷键可以为Enter键。
  • 模板内容设定
    1、Template text 内容:
**
 * @author YourName
 * @date $time$ $date$
 * @method $name$
 * @brief 
 * @Param $param$
 * @return $return$
 */

2、Edit variables 编辑变量内容:
idea 类注释 和 方法注释 模板 制定_第6张图片
直接编辑Expression一列各个对应的内容,进行选择设定内容即可。

  • 效果展示
    键入/*,然后按入回车键(Enter),即可快速添加模板注释内容,效果如下:
    idea 类注释 和 方法注释 模板 制定_第7张图片

你可能感兴趣的:(编程工具)