scottpledger / phpdoc-md
PHP 文档生成器,支持 Markdown 输出
0.1.0
2014-09-01 20:10 UTC
Requires
- php: >=5.3.1
- twig/twig: ~1.16.0
Requires (Dev)
- phpdocumentor/phpdocumentor: ~2.7.0
This package is not auto-updated.
Last update: 2024-09-24 04:10:32 UTC
README
这是一个可以为您 API 文档生成 markdown (.md) 文件的脚本。
此项目针对使用 PSR-0、PSR-1、PSR-2 和 PHP 5.3 命名空间的项目进行优化。该项目主要针对 SabreDAV 开发,但也应适用于其他代码库。
它仅记录类和接口。
代码写得不好,原本只是作为一个一次性项目,因为我当时很匆忙。所以代码库可能不符合您的标准。(当然,也不符合我的标准)。
安装
该项目假设您已经安装了 composer。只需将以下内容添加到您的 composer.json 中:
"require-dev" : {
"evert/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