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


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


目录
相关文章
|
6月前
|
消息中间件 缓存 弹性计算
纯PHP+MySQL手搓高性能论坛系统!代码精简,拒绝臃肿
本内容分享了一套经实战验证的社交系统架构设计,支撑从1到100万用户的发展,并历经6次流量洪峰考验。架构涵盖客户端层(App、小程序、公众号)、接入层(API网关、负载均衡、CDN)、业务服务层(用户、内容、关系、消息等服务)、数据层(MySQL、Redis、MongoDB等)及运维监控层(日志、监控、告警)。核心设计包括数据库分库分表、多级缓存体系、消息队列削峰填谷、CQRS模式与热点数据动态缓存。同时提供应对流量洪峰的弹性伸缩方案及降级熔断机制,并通过Prometheus实现全链路监控。开源建议结构清晰,适合大型社交平台构建与优化。
232 11
|
3月前
|
存储 缓存 安全
php项目源码加密之Zend Guard Loader加密的代码解密可能性很小-优雅草卓伊凡
php项目源码加密之Zend Guard Loader加密的代码解密可能性很小-优雅草卓伊凡
117 2
|
11月前
|
人工智能 C++ iOS开发
ollama + qwen2.5-coder + VS Code + Continue 实现本地AI 辅助写代码
本文介绍在Apple M4 MacOS环境下搭建Ollama和qwen2.5-coder模型的过程。首先通过官网或Brew安装Ollama,然后下载qwen2.5-coder模型,可通过终端命令`ollama run qwen2.5-coder`启动模型进行测试。最后,在VS Code中安装Continue插件,并配置qwen2.5-coder模型用于代码开发辅助。
18340 7
|
8月前
|
人工智能 自然语言处理 API
Cline:29.7K Star!一文详解VSCode最强开源AI编程搭子:一键生成代码+自动跑终端+操控浏览器...
Cline 是一款集成于 VSCode 的 AI 编程助手,支持多语言模型,实时检查语法错误,帮助开发者提高编程效率。通过智能化手段,Cline 可以生成代码、执行终端命令、调试 Web 应用,并扩展更多功能。
2463 73
|
7月前
|
人工智能 网络安全 开发工具
vscode代码推送到github库菜鸡专用教程
vscode代码推送到github库菜鸡专用教程
|
10月前
|
PHP 开发者 容器
PHP命名空间深度解析:避免命名冲突与提升代码组织####
本文深入探讨了PHP中命名空间的概念、用途及最佳实践,揭示其在解决全局命名冲突、提高代码可维护性方面的重要性。通过生动实例和详尽分析,本文将帮助开发者有效利用命名空间来优化大型项目结构,确保代码的清晰与高效。 ####
147 20
|
11月前
|
供应链 安全 NoSQL
PHP 互斥锁:如何确保代码的线程安全?
在多线程和高并发环境中,确保代码段互斥执行至关重要。本文介绍了 PHP 互斥锁库 `wise-locksmith`,它提供多种锁机制(如文件锁、分布式锁等),有效解决线程安全问题,特别适用于电商平台库存管理等场景。通过 Composer 安装后,开发者可以利用该库确保在高并发下数据的一致性和安全性。
145 6
|
11月前
|
PHP 开发者 UED
探索PHP中的异常处理:提升代码的健壮性
在PHP开发中,优雅地处理错误和异常是确保应用稳定性和用户体验的关键。本文将通过深入浅出的方式,介绍如何在PHP中实现有效的异常处理机制,包括异常的基本概念、如何抛出和捕获异常,以及最佳实践。准备好让你的代码变得更加健壮和可靠吧!
93 2
|
11月前
|
PHP 开发者
PHP中的异常处理:提升代码的健壮性
【10月更文挑战第40天】在PHP编程中,异常处理是确保应用稳定性的关键。本文将引导你理解异常处理的重要性,掌握如何在PHP中捕获和处理异常,以及如何通过自定义异常类来增强代码的错误管理能力。我们将一起探索如何利用PHP的异常处理机制,打造一个更加健壮和可靠的应用程序。
|
JavaScript Java PHP
PHP注释的三种方法
PHP一共有三种注释方法,LAMPLNMP详细介绍: eg: 1、单行注释“//”;2、单行注释“#”;3、多行注释“/ 注释文字 /”。
3369 0