README

phpdoc-md是一个从PHPDOC注释生成美观文档的工具。此工具的意图与标准PHPDocumentator略有不同。它专注于类实例，首先生成公共方法的文档。当类继承自其他类时，父类和子类的完整接口将作为其一部分呈现，但继承的方法将被放置在单独的章节中。

phpdoc-md通过项目根目录中的单个.phpdoc-md.php文件进行配置。

示例.phpdoc-md.php文件

<?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',
    ],
];

您可以在此处查看此工具生成的示例文档。

xety / phpdoc-md

维护者

详细信息

README