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

简介: 在vscode中点击扩展-->安装插件koroFileHeader

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

e99961d7b2bc474c8cf622e92f1697c9.png


2.进行配置


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

e5abdc8a348c4ce1ba3b91c448e9ed87.png


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


697b239ff7e34129a582b313a87da600.png


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


1.// 此为头部注释
"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


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


目录
相关文章
|
9天前
|
JavaScript 前端开发 C++
vscode编辑器中如何调试nextjs代码
代码可调式的重要性不言而喻。 对于Programer来说,自己编写的程序能够被优雅调试是一件幸福的事情,特别是习惯了后端程序调试的开发者... 在折腾Nextjs项目的日子里,我走了很多弯路才弄明白在vs code中如何优雅的调试代码。
vscode编辑器中如何调试nextjs代码
|
3天前
|
JSON Ubuntu JavaScript
工具分享:VsCode注释神器,koro1FileHeader
工具分享:VsCode注释神器,koro1FileHeader
10 3
|
6天前
|
Ubuntu PHP Apache
蓝易云 - 如何在Ubuntu 22.04上安装PHP8.1并设置本地开发环境
以上就是在Ubuntu 22.04上安装PHP 8.1并设置本地开发环境的步骤。
14 2
|
1天前
|
自然语言处理 JavaScript Java
php的代码实现分享
php的代码实现分享
|
1天前
|
XML 前端开发 JavaScript
高质量的PHP代码的技巧
高质量的PHP代码的技巧
|
1天前
|
XML 关系型数据库 MySQL
php常用代码分享
php常用代码分享
|
1天前
|
Java 程序员 PHP
三个PHP常用的代码例子
三个PHP常用代码样例
|
1天前
|
XML 移动开发 监控
分享高效率开发PHP程序的代码
9段高效率开发PHP程序的代码
|
1天前
|
XML 前端开发 API
分享好用便捷的 PHP 代码
21 段实用便捷的 PHP 代码