phpDocumentor 死了吗？

Posted 2023-02-22

【中文标题】phpDocumentor 死了吗？

【英文标题】：Is phpDocumentor dead?

【发布时间】：2011-07-31 20:45:28

【问题描述】：

还是只是处于“完成”状态？多年来，我在所有 php 项目中都使用 PHPDoc，但最近我注意到 PHPDoc 网站上的最后一篇文章是 2008 年的。所以我想知道是否是时候研究 Doxygen 等其他替代品了。使用 PHPDoc 以外的东西有什么好处吗？

编辑：今天 Matthew 宣布发布 Zend Framework 1.11.5 时，在 Dev Zone 上发布了一篇有趣的帖子，他写道：

“Mike van Riel 提出将我们的 API 文档生成转换为 DocBlox。我们已经考虑将它用于 ZF2，但看到模板系统的灵活性，更重要的是，对于我们而言，在打包方面，速度以及它在生成输出时使用的最少资源，我们被出售了。（API 文档生成时间从 80-100 分钟减少到不到 10 分钟。）您可以自己查看结果。 http://devzone.zend.com/article/13643

这就是我担心的原因，如果像 Zend Framework 这样的大型项目正在放弃 phpDoc，在我看来，phpDoc 的不活动似乎不会被忽视。 100 分钟缩短到 10..这是我喜欢听到的。

@gms8994 好电话

*更新：原来 DocBlox 是伪装/重新命名的 PHPDocumentor2。 http://www.docblox-project.org/

【问题讨论】：

我也很想知道这个问题的答案。很长一段时间没有看到该项目的任何活动。或者我真的很想知道一个好的替代方案。

尝试github.com/theseer/phpdox 进行更改。

另一种选择是DocBlox。

我投票结束这个问题，因为它是基于时间的。 PhpDoc 的开发曾经放缓，现在它还活得好好的，一些替代品正在苦苦挣扎。几年后情况可能会完全不同。在目前的状态下，它只是令人困惑和/或误导。

【参考方案1】：

虽然我目前也使用 doxygen，但我必须发布 PHPDocumentor 并没有死。取而代之的是，DocBlox 项目所做的尝试共同构成了PHPDocumentor2 的基础，该网站拥有一个全新的网站。这些天来，我不相信它已经准备好生产，但它看起来确实很有希望。

【参考方案2】：

我最近使用 Doxygen 为 PHP 生成文档。这是用于文档的开源工具，也支持其他语言。我会说这是一个很好的工具，它也很容易生成文档作为类图并具有许多可配置的特性。它可用于 Windows 以及 UNIX/LINUX

Can Find the latest release and DOWNLOAD Here

【参考方案3】：

为什么要修复没有损坏的东西？ PHPDoc 工作得很好，真的不需要任何其他东西。他们不是在尝试创新，只是为了帮助创建文档。他们做得很好。

【讨论】：

是的，我明白了，“如果它没有坏就不要修复它”，我当然不同意。我担心的是，如果新版本的 PHP（例如 php6）或 phpDoc 不支持的新功能在 phpDoc 中出现问题，phpDoc 社区中是否有人会加强和快速修复？我的问题的第二部分，我会更好地解释一下，是否有 Doxygen 或 phpDox（或任何其他 doc 程序）必须具有的功能，可以作为一个令人信服的论点来切换？

我认为有足够多的开源项目使用 phpDoc 项目，或者用户自己会加紧帮助修补它。例如，CakePHP 是一个庞大的 php 框架，并且每天都在改进，它大量使用 phpDoc。我的雇主大量使用 PhpDoc，不胜枚举。我知道我们试图为 CakePHP 做出贡献，而修补 PhpDoc 本身就是一种贡献。

好吧，当 PHP 6 出来时，他们可以重振它。在那之前，有什么问题？

他们会吗？似乎有人会，但你不能肯定地说。无论如何，我希望看到有人现在正在研究它，如果只是为了尝试减少它的内存占用。

根据 Wikipedia PhpDoc 于 2010 年停止开发并正式死亡。此外，就“如果它没有损坏就不要修复它”而言，问题是 PHP 并没有停滞不前。对于 5.2 代码库，PhpDoc 可能还不错，但 5.3 引入了命名空间、后期静态绑定、对 SPL 的各种添加等等。命名空间尤其可能会阻塞 PhpDoc，因为它不理解它们。

【参考方案4】：

我在使用 phpDocumentor 时遇到了几个问题。其中之一是 xml 导出。经过几次尝试修复代码后，我决定寻找替代方案。

我发现并喜欢的是：Rarangi https://bitbucket.org/laurentj/rarangi/wiki/Home

Rarangi is a generator of documents from php source code.

有趣的是，它将信息保存在 mysql 数据库中，您可以制作自己的自定义报告。

【讨论】：

感谢@danip 的建议，就像上面提到的两个一样，它看起来有一个良好的开端，但它还很年轻，看起来还没有太多的社区支持。我也会留意的。

【参考方案5】：

phpDocumentor v3（具有适当的 PHP 7 支持）目前是 alpha 版本，真正接近稳定版本。问题是他们没有很多人在做这件事，所以开发很慢。

我已经在我的一个 Symfony 项目中测试了最新的 alpha 版本，它可以正常工作，尽管它缺少一些功能并且有几个错误。当然，他们都被举报了。

https://github.com/phpDocumentor/phpDocumentor/releases

更新： phpDocumentor v3 刚刚进入测试阶段。检查版本。