crazyfactory/docblocks
Composer 安装命令:
composer require crazyfactory/docblocks
包简介
A library for parsing and working with php docblocks from within your code.
关键字:
README 文档
README
Parses php doc blocks and makes them easily accessible.
This is based on using reflection and results should be heavily cached or only be used in processes which aren't time critical.
Install
Run composer require crazyfactory/docblocks to install the latest version into your composer powered project.
Usage
You can pass in any doc-block formatted string into the constructor of DocBlock to have it parsed.
$dc = new DocBlock('/** myDocBlockString */');
Or you can pass in any Reflection object offering getDocComment() like ReflectionMethod, ReflectionClass etc.
$dc = new DocBlock(new \ReflectionClass(MyClass::class));
If you only care for the results in form of simple DocBlockParameter-array you can use the parser directly.
$results = DocBlock::parse($myDocBlockString);
Changelog
- 2.0.0 added auto-deploy via travis CI with githubtags as version-nr.
crazyfactory/docblocks 适用场景与选型建议
crazyfactory/docblocks 是一款 基于 PHP 开发的 Composer 扩展包,目前已累计 887 次下载、GitHub Stars 达 0, 最近一次更新时间为 2018 年 08 月 23 日, 在 PHP 生态内属于活跃度较高的组件。
它主要适用于以下技术方向: 「reflection」 「docs」 「docblock」 等业务场景。在实际项目中,围绕这些方向常见需要落地的问题包括:接口对接、性能调优、并发安全、与既有框架(Laravel / ThinkPHP / Yii / Webman 等)的兼容适配,以及生产环境的日志埋点与稳定性保障。
我们在过去多个企业项目中使用过 crazyfactory/docblocks 或与其功能相近的方案,如果你在选型或落地过程中遇到问题,例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查,欢迎联系我们协助评估。
基于 crazyfactory/docblocks 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复;针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维;也可按月提供技术保姆服务。
与 crazyfactory/docblocks 相关的其它包
同方向 / 同关键字的高下载量 PHP Composer 包推荐,方便对比选型:
Library emulating the PHP internal reflection using just the tokenized source code.
A simple tool for checking that your PHP classes and methods use PHPDocs (PHP DocBlocks Checker fork).
Bookdown.io With Bootswatch Styles And Prism Syntax Highlighting
Parse use statements for a reflection object
Api documentation generator for Laravel 5
Replacement for Swagger. It is built for Laravel
统计信息
- 总下载量: 887
- 月度下载量: 0
- 日度下载量: 0
- 收藏数: 0
- 点击次数: 6
- 依赖项目数: 1
- 推荐数: 0
其他信息
- 授权协议: MIT
- 更新时间: 2018-08-23