vscode添加新建文件头部注释和函数注释

  • Post author:
  • Post category:其他



  • 新建文件作者注释和方法函数注释
  • 搜索添加koroFileHeader 插件,安装之后reload

  • ctrl+shift+p 搜索setting,然后搜索FileHeader点击并且进入setting界面(json界面亦可)

  • 右侧注释代码如下
//配置新建文件注释和方法注释
"fileheader.configObj": {
    "createFileTime": true,//设置为true则为文件新建时候作为date,否则注释生成时间为date
    "autoAdd": true,//自动生成注释,老是忘记的同学可以设置
    "annotationStr": {
      "head": "/*",
      "middle": " * @",
      "end": " */",
      "use": true//设置自定义注释可用
    },
    "headInsertLine": {
      "php": 2
    }
  },
  "fileheader.cursorMode": {
    "description":"",
    "param ":"",
    "return":""
  },
  "fileheader.customMade": {
    "Description":"" ,//文件内容描述
    "Author":"huacong",//编辑人
    "Date": "Do not edit",//时间
    "LastEditTime": "Do not edit",
    "LastEditors": "huacong",
  }

  • 若没有设置自动生成注释

  1. 文件头部添加注释:

    快捷键:

    window



    ctrl+alt+i

    ,

    mac



    ctrl+cmd+i


  2. 在光标处添加函数注释:

    快捷键:

    window



    ctrl+alt+t

    ,

    mac



    ctrl+cmd+t(


    快捷键如果没有生效,注意简介快捷键是否被占用


    )


重启之后生效,如下




版权声明:本文为D_claus原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。