tomrf/readme-gen

为 PHP 包生成带有公共 API 文档的说明文件

维护者

详细信息

github.com/tomrf/readme-gen

主页

源代码

问题

安装: 29

依赖项: 5

建议者: 0

安全: 0

星标: 1

关注者: 1

分支: 0

公开问题: 0

0.0.9 2022-11-11 00:10 UTC

Requires

Requires (Dev)

MIT c19f384a8dbd64b8157e157c4151ea306389a093

documentationmarkdownreadmeREADME.md

This package is auto-updated.

Last update: 2024-09-20 03:15:29 UTC

README

PHP Version Require Latest Stable Version License

自动生成带有公共 API 文档的 📚 README 文件，基于 composer.json 中的 docblocks 和包信息

包含的格式化工具

  • Markdown

📔 前往文档

安装

通过 composer 安装

composer require tomrf/readme-gen

使用方法

$readmeGen = new \Tomrf\ReadmeGen\ReadmeGen('.'); // path to project directory

echo $readmeGen->generate(
    new Tomrf\ReadmeGen\Formatter\MarkdownFormatter(
        \phpDocumentor\Reflection\DocBlockFactory::createInstance(),
        new \phpDocumentor\Reflection\Types\ContextFactory()
    ),
    'resources/template.md'
);

测试

composer test

许可证

本项目采用 MIT 许可证 (MIT) 发布。更多信息请参见 LICENSE

文档

📂 Tomrf\ReadmeGen\ReadmeGen::class

ReadmeGen.

这是一个非常正在进行中的工作。

__construct()

public function __construct(
    string $projectRoot
): void

generate()

public function generate(
    Tomrf\ReadmeGen\Interface\ReadmeFormatterInterface $formatter,
    string $templateFilename
): string

使用 📚 tomrf/readme-gen 生成，时间为 2022-06-15T22:33:50+02:00