liz/easy-doc-bundle

Composer 安装命令：


                            composer require liz/easy-doc-bundle

包简介

Symfony application documentation generator

关键字：

#generator #documentation #project #doc

README 文档

README

Thanks easycorp/easy-doc-bundle This bundle generates the formal documentation for Symfony applications. This documentation is a HTML document that contains detailed information about every application element (routes, services, events, configuration, etc.)

When would this bundle be useful?

As a reference to look for any application element details.
As a document to get an overall idea of the application when adding new developers to the project.
As a deliverable to the client who paid for the application development.
As a searchable archive of legacy applications.

This is how it looks:

Installation

Step 1: Download the Bundle

$ composer require --dev liz/easy-doc-bundle

Step 2: Enable the Bundle

// app/bundles.php

// ...

return [
    // ...
    Liz\Bundle\EasyDocBundle\EasyDocBundle::class => ['dev'=>true, 'test'=>true],
    // ...
];

Usage

Run the doc command in your Symfony application to generate the documentation:

$ cd your-project/
$ ./bin/console doc

liz/easy-doc-bundle 适用场景与选型建议

liz/easy-doc-bundle 是一款基于 HTML 开发的 Composer 扩展包，目前已累计 34 次下载、GitHub Stars 达 0，最近一次更新时间为 2019 年 02 月 21 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「generator」「documentation」「project」「doc」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 liz/easy-doc-bundle 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 liz/easy-doc-bundle 我们能提供哪些服务？

定制开发 / 二次开发

基于 liz/easy-doc-bundle 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发