PHP Chinese Documentation
一个 VS Code / Kiro 扩展,当你将鼠标悬停在 PHP 函数上时,自动显示该函数的中文文档。
✨ 功能特性
- 🎯 鼠标悬停自动显示 - 将鼠标悬停在 PHP 函数上,自动显示中文文档
- 📚 支持所有 PHP 内置函数 - 覆盖 PHP 官方文档的所有函数
- 🌐 在线获取最新文档 - 从 PHP 官方中文网站实时获取文档
- ⚡ 智能缓存机制 - 可配置的缓存功能,提升响应速度
- 🎨 语法高亮显示 - 代码示例带有完整的语法高亮
- 📖 完整文档内容 - 包含函数说明、语法、参数、返回值、示例代码等
🚀 使用方法
- 安装扩展
- 打开任意 PHP 文件
- 将鼠标悬停在 PHP 函数上(如
array_map、strlen 等)
- 自动显示中文文档悬浮窗
⚙️ 配置选项
点击扩展右侧的齿轮图标 ⚙️ → 选择"扩展设置",可以配置以下选项:
phpChineseDoc.enabled
- 类型:布尔值
- 默认值:
true
- 说明:启用/禁用 PHP 中文文档悬停提示
phpChineseDoc.enableCache
- 类型:布尔值
- 默认值:
true
- 说明:启用文档缓存(提高响应速度)
- ✅ 启用(推荐):文档会被缓存,响应速度快
- ❌ 禁用:每次都重新获取文档,确保内容最新
phpChineseDoc.apiUrl
- 类型:字符串
- 默认值:
https://www.php.net/manual/zh/
- 说明:PHP 中文文档 API 地址
📝 支持的函数
支持所有 PHP 内置函数,包括但不限于:
- 数组函数:
array_map, array_filter, array_reduce, array_merge 等
- 字符串函数:
strlen, substr, str_replace, explode 等
- 文件函数:
file_get_contents, fopen, fwrite, fclose 等
- 数据库函数:
mysqli_connect, mysqli_query, PDO 相关等
- JSON 函数:
json_encode, json_decode 等
- 其他所有 PHP 官方函数
🎯 使用技巧
- 快速查看文档:将鼠标悬停在函数上即可,无需打开浏览器
- 查看完整文档:点击悬浮窗底部的"查看完整官方文档"链接
- 缓存:在设置中关闭
Enable Cache,每次获取最新文档
🔧 常见问题
1. 没有显示文档?
- 确保光标悬停在函数名上,且函数后面有括号
()
- 检查网络连接,扩展需要访问 php.net
- 检查扩展是否已启用:设置 →
phpChineseDoc.enabled 应为 true
2. 文档显示不完整?
- 首次加载可能较慢(需要从网络获取),请稍等片刻
- 已缓存的文档会立即显示
3. 如何更新文档?
👤 作者
仓颉
如有问题或建议,欢迎反馈!
| |