liz/easy-doc-bundle

Symfony 应用文档生成器

安装: 33

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 8

语言:HTML

类型:symfony-bundle

v2.3 2019-02-26 07:09 UTC

This package is auto-updated.

Last update: 2024-08-29 04:48:36 UTC


README

感谢 easycorp/easy-doc-bundle 本扩展用于生成 Symfony 应用的正式文档。该文档是一个包含每个应用元素(路由、服务、事件、配置等)详细信息的 HTML 文档。

何时使用此扩展?

  • 作为查找任何应用元素详细信息的参考。
  • 作为添加新开发人员到项目时获取应用整体概念的文档。
  • 作为向支付应用开发费用的客户交付的成果。
  • 作为历史应用的 可搜索 归档。

它看起来是这样的

EasyDoc in action

安装

步骤 1:下载扩展

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

步骤 2:启用扩展

// app/bundles.php

// ...

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

用法

在您的 Symfony 应用中运行 doc 命令以生成文档

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