easycorp / easy-doc-bundle
Symfony 应用文档生成器
v1.1.1
2017-01-27 07:32 UTC
Requires
- php: >=5.3.3
- symfony/dependency-injection: ~2.3|~3.0
- symfony/framework-bundle: ~2.3|~3.0
- symfony/twig-bridge: ^2.3.4|~3.0
- symfony/twig-bundle: ~2.3|~3.0
- twig/extensions: ~1.0
- twig/twig: ~1.14,>=1.14.2|~2.0
This package is auto-updated.
Last update: 2024-09-06 09:50:07 UTC
README
此bundle用于生成Symfony应用的正式文档。该文档是一个HTML文档,包含关于每个应用元素(路由、服务、事件、配置等)的详细信息。
何时使用此bundle?
- 作为查找任何应用元素详细信息的参考。
- 作为新开发人员加入项目时了解应用的文档。
- 作为向为应用开发付费的客户交付的成果。
- 作为旧应用的可搜索存档。
看起来是这样的
安装
步骤 1: 下载Bundle
$ composer require --dev easycorp/easy-doc-bundle
步骤 2: 启用Bundle
// app/AppKernel.php // ... class AppKernel extends Kernel { public function registerBundles() { // ... if (in_array($this->getEnvironment(), ['dev', 'test'])) { // ... if ('dev' === $this->getEnvironment()) { // ... $bundles[] = new EasyCorp\Bundle\EasyDocBundle\EasyDocBundle(); } } } // ... }
用法
在您的Symfony应用中运行doc
命令以生成文档
$ cd your-project/
$ ./bin/console doc