README

phpDox 是一个用于 PHP 项目的文档生成器。这包括但不限于 API 文档。主要重点是丰富生成的文档，增加如代码覆盖率、复杂度信息等额外细节。

要求

PHP 版本 7.1+（对于 PHP 5.5+，请使用 phpDox 0.11.2）
- ext/dom
- ext/xsl
- ext/iconv 和 libiconv 版本 >= 2.12
PHPParser PHP 解析器 API
fDOMDocument
DirectoryScanner
fXSL
PHP_Timer

phpDox 以自包含的执行 Phar 归档形式提供。您可以从发布部分获取您的副本，或使用phive进行安装。

phive install phpdox

现在您可以在命令行上执行 phpdox

tools/phpdox --version

如果一切顺利，您应该会看到类似以下输出

phpDox 0.11.2 - Copyright (C) 2010 - 2018 by Arne Blankerts and Contributors

注意：一些 Linux 发行版随 PHP 一起提供 ext/suhosin 并禁用 phar 执行。要在这种环境中使用 phpDox，您需要通过将 phar 添加到执行器白名单来启用 phar 执行：suhosin.executor.include.whitelist="phar"

此外，phpDox 可以通过 composer 安装

composer require --dev theseer/phpdox

现在您可以在命令行上执行 phpdox

vendor/bin/phpdox --version

如果一切顺利，您应该会看到类似以下输出

phpDox 0.11.2 - Copyright (C) 2010 - 2018 by Arne Blankerts and Contributors

如果您想尝试最新版本或修改源代码，您将需要克隆此存储库。

git clone git://github.com/theseer/phpdox.git
composer install

您可以像这样运行 phpDox

phpdox --help

从版本 0.4 开始，phpDox 需要 xml 配置文件。如果您要生成文档的项目没有包含配置文件，您可以创建一个，方法是在命令中调用

phpdox --skel > phpdox.xml.dist

示例调用：基于默认的 phpdox.xml 配置文件解析并生成输出

phpdox

或者，您可以通过调用 phpdox 来指定配置文件，使用 --file 或简写

phpdox -f path/to/phpdox.xml