devtools/docgen

文档生成工具

维护者

详细信息

github.com/tanjiancheng/devtools-docgen

源代码

问题

安装次数: 23

依赖: 0

建议者: 0

安全性: 0

星标: 1

关注者: 1

分支: 0

开放问题: 0

语言:HTML

类型:l

1.1.2 2020-02-11 03:33 UTC

Requires

Requires (Dev)

MIT d61cb1e016d0b602f69a06b354f5ec0bae13b753

  • tanjiancheng <tanjianchengcc.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-11 14:41:22 UTC

README

安装

composer require devtools/docgen

用法

<?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目录

截图

html-snapshoot