devtools/docgen

文档生成工具

1.1.2 2020-02-11 03:33 UTC

Requires

• php: >=7.2
• guzzlehttp/guzzle: ^6.2
• michelf/php-markdown: ^1.7
• symfony/yaml: ^5.0

Requires (Dev)

• phpunit/phpunit: ^7.0.0

MIT

• tanjiancheng

README

Install

composer require devtools/docgen

Usage

<?php

use Devtools\Docgen\Outer;
use Devtools\Docgen\Parser;
use Devtools\Docgen\Scaner;

require(dirname(__DIR__) . '/vendor/autoload.php');

$scaner = new Scaner();
$scaner->setPaths([
    dirname(__DIR__) . '/example/Src'
]);
$scaner->setSuffixs([
    '.php'
]);
$parser = new Parser($scaner);
$overview = $parser->getOverview(); //获取文档总概况
$apis = $parser->getApis();         //获取接口对象数组

$outer = new Outer($parser);

//生成markdown文件
$link = $outer->toMarkDown([
    //'stream' => 'php://stdout',   //输出到控制台
    'stream' => __DIR__ . '/Doc/api.md',       //输出到指定文件
]);
if (is_file($link)) {
    echo "== markdown文档链接 ==" . PHP_EOL . $link . PHP_EOL . PHP_EOL;
}

//生成html文件
$link = $outer->toHtml([
    //'stream' => 'php://stdout',   //输出到控制台
    'stream' => __DIR__ . '/Doc/api.html',       //输出到指定文件
]);
if (is_file($link)) {
    echo "== html文档链接 ==" . PHP_EOL . $link . PHP_EOL . PHP_EOL;
}

详细例子可以查看example目录

Screenshot