[PHP知识库]工具-VsCode插件koroFileHeader

VsCode插件koroFileHeader设置文件头注释和函数注释

1. 在线安装
2. 离线安装

本文档讲离线安装

第一步：下载https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE

第二步：2.文件->首选项->设置->搜索fileheader->settings.json编辑

{
"fileheader.Author": "lishuwei",

// 插件配置选项,readme:https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE
//配置新建文件注释和方法注释
"fileheader.configObj": {
    "createFileTime": true,//设置为true则为文件新建时候作为date，否则注释生成时间为date
    "autoAdd": true,//自动生成注释，老是忘记的同学可以设置
    "annotationStr": {
    "head": "/*", // 自定义注释头部
    "middle": " * @", // 自定义注释中间部分(注意空格,这也是最终生成注释的一部分)
    "end": " */", // 自定义注释尾部
    "use": true // 是否使用自定义注释符号
    },
    //头部注释第几行插入
    "headInsertLine": {
    "php": 2,
    "*": 1, // 所有文件都在第1行插入注释(除了php)
    }
},

//函数注释 快捷键：window：ctrl+alt+t,mac：ctrl+cmd+t
"fileheader.cursorMode": {
    "name":"",
    "description":"",
   // "test":"test font",
   // "msg":"",
    "param":"",
    "return":"",
    "author":"",

},

//文件头部注释 快捷键：window：ctrl+alt+i,mac：ctrl+cmd+i
"fileheader.customMade": {
    "Description":"" ,//文件内容描述
    "Author":"lishuwei",//编辑人
    "Date": "Do not edit",//文件创建时间(不变)
    "FilePath": "Do not edit", // 文件在项目中的相对路径 自动更新
    "LastEditTime": "Do not edit",//文件最后编辑时间
    "LastEditors": "MelodyJerry"
},
"window.zoomLevel": -1
}

3.保存退出,重启vscode

4.快捷键

ctrl+alt+i?插入文件头注释

ctrl+alt+t 插入函数头注释

参考：

https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE

https://blog.csdn.net/weixin_43438052/article/details/114108437?utm_medium=distribute.pc_relevant.none-task-blog-2~default~baidujs_baidulandingword~default-0.control&spm=1001.2101.3001.4242