README

phpdoc-md 是一个工具，可以从 PHPDOC 注释生成美观的文档。

它允许生成易于阅读和直接在 github、gitlab 或 bitbucket 网站上跟踪的 markdown 文档文件。

您可以在这里看到该工具生成的示例文档。

此工具的目的是与标准的 PHPDocumentator 稍有不同。它侧重于类实例，首先从公共方法生成文档。当类继承自其他类时，父类和子类的完整接口将作为其一部分呈现，但继承的方法将放在单独的章节中。

如何使用它？

phpdoc-md 通过位于项目根目录的单个（php 格式）.phpdoc-md 文件进行配置。

.phpdoc-md 文件示例

<?php
return (object)[
    'rootNamespace' => 'Clean\PhpDocMd\Example', 
    'destDirectory' => 'docs',
    'format' => 'github',
    'classes' => [
        '\Clean\PhpDocMd\Example\Basic',
        '\Clean\PhpDocMd\Example\Deep\Foo',
        '\Clean\PhpDocMd\Example\ExtendClass',
        '\Clean\PhpDocMd\Example\ExtendExtendClass',
    ],
];

clean / phpdoc-md

维护者

详细信息

README

如何使用它？