README

这是一个可以生成 API 文档的 Markdown (.md) 文件的脚本。

它适用于使用 PSR-0、PSR-1、PSR-2、PSR-4 和命名空间的项目。该项目主要用于 sabre/dav，但也应适用于其他代码库。

它仅记录类和接口。

代码很丑陋，它只打算是一次性的，而且我当时很匆忙.. 所以代码库可能不符合你的标准。（它当然不符合我的标准）。

安装

该项目假设你已经安装了 composer。只需将以下内容添加到你的 composer.json 中，然后你可以简单地使用以下命令进行安装：

"require-dev" : {

    "skayo/phpdoc-md" : "~0.2.0"

}

composer install

但我建议使用以下命令全局安装：

composer global require skayo/phpdoc-md

这确保了你可以在电脑的任何地方使用 phpdocmd 命令。

使用方法

首先确保 phpdocumentor 2 已安装在某处，然后你必须生成一个名为 structure.xml 的文件。

最简单的方法是创建一个临时目录，例如命名为 docs/。

# phpdoc command
phpdoc  -d [project path] -t docs/ --template="xml"

# Next, run phpdocmd:
phpdocmd docs/structure.xml [outputdir]

选项

--lt [template]
    This specifies the 'template' for links we're generating. By default
    this is "%c.md".

--index [filename]
    This specifies the 'filename' for API Index markdown file we're generating.
    By default this is "ApiIndex.md".

这应该会生成所有的 .md 文件。我很期待听到你的反馈。

干杯，Evert

skayo / phpdoc-md

维护者

详细信息

README

安装

使用方法

选项