README

phpDocumentor 模板，用于生成仅包含公共 API 的 Markdown 文档。它将跳过所有抽象类和非公共方法。

此模板的主要用途是生成简单且美观的使用文档，然后可以将其发布在 GitHub 上。

例如，一个小型库可以在 DocBlock 注释中记录其公共 API，使用此模板生成 Markdown 文档，然后将它与库一起提交到 GitHub，以便为其他开发者创建美观的文档。

使用此模板生成的文档示例：https://github.com/cvuorinen/raspicam-php/tree/master/docs

安装

使用 composer 安装

composer require cvuorinen/phpdoc-markdown-public

使用方法

运行 phpDocumentor 并将模板设置为 vendor/cvuorinen/phpdoc-markdown-public/data/templates/markdown-public。

使用命令行参数的示例

./vendor/bin/phpdoc --directory=src/ --target=docs/ --template="vendor/cvuorinen/phpdoc-markdown-public/data/templates/markdown-public" --title="My Project Documentation"

有关可用参数的更多信息，请参阅运行 phpDocumentor。

使用配置文件的示例

将名为 phpdoc.xml 的文件添加到项目的根目录，并使用不带参数的 phpdoc 命令调用。根据您的项目修改配置。

<?xml version="1.0" encoding="UTF-8" ?>
<phpdoc>
    <title>My Project Documentation</title>
    <parser>
        <target>build</target>
    </parser>
    <transformer>
        <target>docs</target>
    </transformer>
    <transformations>
        <template name="vendor/cvuorinen/phpdoc-markdown-public/data/templates/markdown-public" />
    </transformations>
    <files>
        <directory>src</directory>
        <ignore>test/*</ignore>
    </files>
</phpdoc>

有关配置 phpDocumentor 的更多信息。

nilwer / phpdoc-markdown-public

维护者

详细信息

README

安装

使用方法