vscode添加PHP代码注释的插件及设置教程

1.在vscode中点击扩展-->安装插件koroFileHeader

2.进行配置

点击设置按钮 进入配置页面-->搜索fileheader-->settings.json

可以在settings.json文件中设置一些头部注释和函数注释

 

以下列举一些配置代码，也可根据实际情况进行变化

// 此为头部注释
"fileheader.customMade": {
    "Description": "",
    "Version": "2.0",
    "Autor": "ABing",
    "Date": "Do not edit",
    "LastEditors": "lhl",
    "LastEditTime": "Do not edit"
},
// 此为函数注释
"fileheader.cursorMode": {
    "description":"",
    "param": "",
    "return": "",
    "author":"lhl"
},
"fileheader.configObj": {
    // 默认开启自动添加头部注释，当文件没有设置头部注释时保存会自动添加
    "autoAdd": true,
    // 默认开启
    "autoAlready": true, 
    // 禁止.json .md文件，自动添加头部注释
    "prohibitAutoAdd": [
        "json",
        "md"
    ], 
    // 设置为true开启
    "wideSame": false, 
    // 字段长度 默认为13
    "wideNum": 13 
}

3.根据快捷键进行注释

（1）当我们想在对应php文件头部设置注释信息时使用快捷键：

        ctrl+alt+i 备注头部

       如果以上快捷键不奏效可以使用  window+Ctrl+i

（2）当我们想要对类、方法进行注释时

        ctrl+alt+t  备注方法/类

如果以上快捷键不奏效可以使用   window+Ctrl+t

最后也可以使用其他插件，欢迎评论区补充。