PHPackages                             mengcc/mcc-doc - 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. mengcc/mcc-doc

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

mengcc/mcc-doc
==============

php mcc-doc

v0.1(7y ago)061MITPHPPHP >=5.4.0

Since Sep 20Pushed 7y agoCompare

[ Source](https://github.com/mengchenchen/MccDoc)[ Packagist](https://packagist.org/packages/mengcc/mcc-doc)[ RSS](/packages/mengcc-mcc-doc/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (1)DependenciesVersions (2)Used By (0)

MccDoc - API文档生成 [![Build Status](https://camo.githubusercontent.com/deab55e6ef379ac8d6daad406513e74ce91a0ded0cd72958947b78b7c6631c11/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f53656c6461656b2f6d6f6e6f6c6f672e737667)](https://travis-ci.org/Seldaek/monolog)
=================================================================================================================================================================================================================================================================================

[](#mccdoc---api文档生成-)

市面上的接口文档生成都要求 php7+ 以上版本，而且大多数文档生成工具都基于某某个框架，例：

- swgger (php 7+，基于框架)
- apidoc (npm 驱动)

由于当前公司项目是十年前的项目，php 版本低、结构乱，需要对接的第三方接口较多，此项目也就应运而生了。

MccDoc 的特点在于简单易上手依赖较小，只要保证你的 PHP版本 > 5.4 就可以了。

安装
--

[](#安装)

如果你装了 composer ，复制下面这段话就可以获取到最新版本的 MccDoc 了

```
$ composer require mengcc/mcc-doc

```

如果你没有配置 composer 也不要紧，点击下面的按钮直接下载项目。

[![Total Downloads](https://camo.githubusercontent.com/9334f37bf51b7476f861c5ea51c8f3252d368838b400e1a52a4f5a11d5380bbe/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6d6f6e6f6c6f672f6d6f6e6f6c6f672e737667)](https://github.com/mengchenchen/MccDoc/archive/master.zip)

基本使用
----

[](#基本使用)

```
class UserController{

    /**
    * @MccDoc({
    * "name":"获取用户信息",
    * "url":"/api/user/info",
    * "method":"GET",
    * "description":"获取用户信息",
    * })@
    */
    public function info(){}

    /**
    * @MccDoc({
    * "name":"编辑用户",
    * "url":"/api/user/edit",
    * "method":"POST",
    * "description":"编辑用户",
    * "params":{
    *    "name":"小明",
    *    "age":20
    *  },
    * })@
    */
    public function edit(){}
}
```

demo.php

```