README

DocTracer 帮助您创建有意义的 API 文档报告。反映 PHP 类信息，并在一页上显示 Markdown 格式的文档。

访问 DocTracer API 文档查看结果。

安装

composer require qaharmdz/doctracer --dev

用法

创建 DocTracer 实例。

$tracer = new \Mdz\DocTracer($baseDirectory = './');

检查目标目录（相对于 $baseDir）内的所有 PHP 代码。

$tracer->inspect('./../src');
$tracer->inspect('./Library/');

检查结果

获取检查结果数据。

$reports = $tracer->getResults();
var_dump($reports);

HTML 报告

输出 HTML 报告。

echo $output = $tracer->render([
    'title'   => 'DocTracer Test',
    'tagline' => 'PHP ReflectionClass and API documentation',
    'theme'   => 'darkmoon',
]);

保存输出到文件。

file_put_contents('example-api.html', $output);

渲染选项

title 页面标题（h1）和元标题
tagline 页面标题标语
footer 页脚信息。默认: {title} - {tagline}
theme 报告主题。选项: default, darkmoon
css 自定义报告样式
template 自定义模板路径

许可证 (MIT)

特此授予任何获得本软件及其相关文档文件（“软件”）副本的任何人免费使用软件的权利，不受任何限制，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本的权利，并允许将软件提供给其他人，以便他们可以这样做，前提是受以下条件约束

qaharmdz / doctracer

维护者

详细信息

README

安装

用法

检查结果

HTML 报告

许可证 (MIT)