PHPDoc 的状态如何？ [关闭]答案

【问题标题】：What is the status of PHPDoc? [closed]PHPDoc 的状态如何？ [关闭]
【发布时间】：2012-01-31 15:11:23
【问题描述】：

我以前从不关心记录我的代码，但最近我开始从事一个开源项目并且需要出现。显然，“首选武器”是 PHPDoc，但是...

我真的找不到 PHPDoc 标准的单一规范。有一个维基百科条目列出了一些属性，还有一个 phpDocumentor 项目，据说它有一个更广泛的字典，但让我困惑的是 PHPDoc 的权威指南在哪里？是否有一个单一的标准，或者由所有那些众多的 phpDocumentor 仿冒品来将 PHPDoc“标准”（如果有的话）扩展到它们看起来合适的任何东西。

如果我们假设 phpDocumentor 是创建和维护 PHPDoc 标准的地方，那么事情看起来很糟糕，因为 the project's website 已经死了大约 4 年了。而更让我不解的是，大约一个月前，一个版本1.4.4突然出现在phpDocumentor的Pear网站上。

我知道这里有很多聪明和博学的人，所以我想知道。与 PHPDoc 有什么关系。是否有一个制定标准的权威机构？它有多可靠？有没有未来，或者我们正在与僵尸打交道，所有希望都失去了......

谢谢，伊沃

【问题讨论】：

不是堆栈溢出的问题
@Dagon - 我不敢苟同。它属于practical, answerable problems that are unique to the programming profession。
作为参考，有一段时间没有更新的网站不会使网站（或项目，就此而言）“死亡”。可能只是 3 年多来没有需要新版本，因为该软件做了它的事情并且做得很好。
@cHao：事实并非如此。它缺乏对 PHP 5.3 功能的支持。文档生成器也很慢而且很麻烦

标签： php documentation phpdoc

【解决方案1】：

根据维基百科it's dead。

PhpDoc 标签的标准规范曾经是 PhpDocumentor 文档中列出的内容。但就像我说的，它已经死了。由于 DocBlox 似乎正在填补 PhpDocumentor 留下的空白，我建议使用 DocBlox documentation 作为您如何执行 PhpDoc cmets 的基础。

我希望 Netbeans 7.1 将引入 DocBlox 支持，因为它要好得多。它支持 PHP 5.3，并且得到积极维护。

【讨论】：

感谢您的评论。我知道那里有无数的文档生成器，但它们似乎都在 PHPDoc 基础上扩展，所以我暗中希望会有一个单一的标准，但我想可能不会。我个人现在选择的生成器是 - apigen.org
如果他们似乎都扩展了 phpDoc...嗯...那应该告诉你一些事情。即，有一个用于 doc cmets 的主要标准。您使用的系统可能会改变，但 cmets 几乎是相同的。
我给几个 phpdocumentor 的开发者发了邮件，他们告诉我这个项目并没有“死”，但不会被增强以获得 php 5.3 的特性（维基百科的文章也相应地更新了，没有不再将项目列为已停产）。我同意@IvoSabev，apigen 是我个人的新宠。

【解决方案2】：

这个问题已经有点老了，但为了提供信息，我应该补充一点，DocBlox 已与 PhpDocumentor 合并。

宣布 phpDocumentor 2 – 合并旧的 (phpDocumentor) 和新的 (DocBlox)。

随着 phpDocumentor (2.0.0a1) 的第一个 alpha 版本，新的 “响应式”默认模板采用新的页面布局，以及原始 DocBlox 模板的有用布局改进在旧的 phpDocumentor 模板上提供（仍然可用）（它将与旧的 phpDocumentor 一起退休）。探索这个新模板在http://demo.phpdoc.org/Responsive/index.html。

=> http://www.docblox-project.org/2012/03/docblox-is-unmasked-it-is-really-phpdocumentor-2/

PHPDoc 又回来了。 =)

【讨论】：

【解决方案3】：

截至 2013 年 8 月，PHP Framework Interoperability Group 开始为 PHPDoc 编写正式规范 (PSR)。 PHPDoc 的提议标准，当前草案 PSR5：https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md

当前的草案更新了规范以解决 PHP 5.3+ 以及已发生的其他更改。我相信这个 php cmets 标准将被多个文档生成器采用。

【讨论】：