PHPackages                             siam/php-docs - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. siam/php-docs

ActiveL[Utility & Helpers](/categories/utility)

siam/php-docs
=============

php

1.0.3(6y ago)018Apache-2.0HTML

Since Apr 3Pushed 6y agoCompare

[ Source](https://github.com/xuanyanwow/phpDocs)[ Packagist](https://packagist.org/packages/siam/php-docs)[ RSS](/packages/siam-php-docs/feed)WikiDiscussions master Synced 1w ago

READMEChangelog (4)Dependencies (3)Versions (5)Used By (0)

PHP 注解文档生成
==========

[](#php-注解文档生成)

从easyswoole组件中抽离出来 适用于php-fpm环境

安装
--

[](#安装)

```
composer require siam/php-docs

```

默认使用
----

[](#默认使用)

适用于普通环境，非框架

```
php vendor/bin/siam-docs tests [要扫描的目录名]

```

框架使用
----

[](#框架使用)

以TP5.1为例，控制器、model等类文件是由框架内置的`自动加载逻辑`完成，所以我们需要自定义一个脚本，来初始化框架的事件

在根目录下新建一个文件`docs.php(任意名字)`，内容如下 `注意查看注释`

```