PHPackages                             lxlxw/api-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. [API Development](/categories/api)
4. /
5. lxlxw/api-doc

ActiveLibrary[API Development](/categories/api)

lxlxw/api-doc
=============

根据注释生成markdown或html形式的接口文档

7196[1 issues](https://github.com/lxlxw/api-note-doc/issues)PHP

Since Mar 27Pushed 9y ago2 watchersCompare

[ Source](https://github.com/lxlxw/api-note-doc)[ Packagist](https://packagist.org/packages/lxlxw/api-doc)[ RSS](/packages/lxlxw-api-doc/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

api-note-doc
============

[](#api-note-doc)

根据注释生成markdown或html形式的API接口文档插件

- [描述/说明](#describe)
- [环境](#requirements)
- [安装](#install)
- [示例](#demo)
- [配置](#config)
- [展示](#show)
- [计划](#todo)

### 描述/说明

[](#描述说明)

- 可以根据api类/方法的注释可以生成markdown或html形式的API接口文档。
- 模版默认为markdown，亦可自定义模版。
- 依赖于composer管理。
- 该插件未经过严格的测试，建议只部署在本地或测试环境使用。

### 环境

[](#环境)

- PHP >= 5.4 或以上
- composer依赖

### 安装

[](#安装)

- 添加下面一行到你项目的composer.json中。

```
{
    "require": {
        ...
        "lxlxw/api-doc": "dev-master"
    }
}
```

- 更新vendor包

```
$ php composer.phar update
```

### 示例

[](#示例)

- 要生成注释的接口类/方法 #testController.php

```