idea设置类和方法注释模板

idea设置类和方法注释模板

1. 设置IDEA中的类模板

   • idea路径： File–>settings–>Editor–>File and Code Templates–>Files

   • 选择Class文件（也可以设置其它文件类型），在模板中填入自己想要的格式

   • @ClassName：$NAME设置类名，与下面的${NAME}一样才能获取到创建的类名

   • @Description：一般生成类或方法都需要添加描述

   • @Author：jxl 作者名称、

   • @Date：$DATE、${TIME}：设置创建类的用户、创建的日期和时间，这些事IDEA内置的方法，还有一些其他的方法在绿色框标注的位置，比如你想添加项目名则可以使用${PROJECT_NAME}

   • @Version：1.0 设置版本号

     

   • 代码片段

     /**
       *@ClassName ${NAME}
       *@Description  TODO
       *@Author jxl
       *@Date ${DATE} ${TIME}
       *@Version 1.0
     **/
     

2. 设置方法注释：

   • 如果想沿用myeclipse的方法注释 myeclipse默认的方法注释的快捷键是 打出来 “/* + enter键盘”，考虑到这种情况，我们把idea方法注释的快捷键设置为 “/*”

   • idea路径： File–>settings–>Editor–>Live Templates

   • 新建自定义模板分组，然后自定义模板

     
     

   • 新建自定义模板分组，然后自定义模板

• 设置生成注释的快捷键

  设置模板：模板内容如下

  注意第一行，只有一个而不是/

  在设置参数名时必须用$参数名$的方式，否则第五步中读取不到你设置的参数名

  *
   * 功能描述 
   * @author jiangxl
   * @date $date$
   * @param $params$ 
   * @return $return$
   */
  

  如果使用/*作为快捷键的话会是这样
  /*/**
   * 功能描述 
   * @author jiangxl
   * @date $date$
   * @param $params$ 
   * @return $return$
   */
  

• 设置模板应用场景

  点击模板页面最下方的警告，来设置将模板应用于那些场景，一般选择EveryWhere–>Java即可

  （如果曾经修改过，则显示为change而不是define）

• 设置模板应用场景

  选择右侧的Edit variables按钮

• 设置模板应用场景

• 点击apply