gkcgautam/phpdoc-md

PHP 文档生成器,支持 Markdown 输出

0.1.0 2014-09-01 20:10 UTC

This package is not auto-updated.

Last update: 2024-09-24 02:18:51 UTC


README

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

它针对使用 PSR-0、PSR-1、PSR-2 和 PHP 5.3 命名空间的项目进行了优化。该项目最初是为 SabreDAV 开发的,但也适用于其他代码库。

它只记录类和接口。

代码比较难看,这是作为一次性使用设计的,我那时候很匆忙,所以代码库可能不符合您的标准。(当然也不符合我的标准)。

安装

假设您已经安装了 composer。只需将以下内容添加到 composer.json 中:

"require-dev" : {

    "gkcgautam/phpdoc-md" : "~0.0.7"

}

composer install

用法

首先确保 phpdocumentor 2 已安装,之后,您必须生成一个名为 structure.xml 的文件。

最简单的方法是创建一个临时目录,例如命名为 docs/,因为 phpDocumentor2 会创建许多 '缓存' 目录。

# phpdoc command
mkdir docs
cd docs
phpdoc  -d [project path] -t . --template="xml"
rm -r phpdoc-cache-*

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

选项

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

这将生成所有 .md 文件。我很期待听到您的反馈。

祝好,Evert