yaf-php-doc
yaf-php-doc copied to clipboard
YAF(Yet Another Framework)源码PHP移植版,同时提供了IDE Helper Doc的能力:bulb::bulb::bulb:
目录
-
1 关于Yaf-PHP
- 1.1 简介
- 1.2 依赖
- 1.3 安装
-
1.4 快速使用
- 1.4.1 PhpStorm引入
- 1.4.2 NetBeans引入
- 1.5 最终效果图
- 2 相关链接
- 3 待解决问题
1. 关于Yaf-PHP
1.1 简介
Yaf-PHP
采用原生PHP对Yaf源码进行了逻辑重写,最大程度还原其相关实现逻辑.
由于采用了原生PHP重写,可达到抹平阅读能力,降低阅读成本的目的.在平常开发时,也可以作为IDE Helper进行引入,加快开发效率.
1.2 依赖
依赖项 | 版本 | 说明 |
---|---|---|
PHP | 7.0+ | IDE运行的PHP环境,并非服务运行环境 |
1.3 安装
> git clone https://github.com/yinggaozhen/yaf-php.git
1.4 快速使用
1.4.1 在PhpStorm引入
两种实现方法
左侧导航栏 `External Libraries` -> `Configure PHP Include Path` -> 添加`Yaf-PHP`文件路径 -> `apply`
菜单 `File` -> `Setting` -> `Languages & Frameworks` -> `PHP` -> 添加`Yaf-PHP`文件路径 -> `apply`
1.4.2 在NetBeans引入
右击你的项目 -> `Properties` -> `PHP Include Path` -> `Add Folder..` -> 添加`Yaf-PHP`文件路径 -> `open`
1.5 最终效果图
2 相关链接
3.待解决问题
- [ ] 接入travis CI/codecov/lint,内容包含单元测试/测试覆盖率/代码规范校验
- [x] 项目中TODO List清理
- [x] 测试用例完善
- [x] README文档完善
- [x] 加载方式同时支持PSR4和PSR0
- [x] 代码注释完善,包括函数入参出参参数说明,以及每个函数作用说明