我之前从未关心过记录我的代码,但最近我开始研究一个开源项目并且需要出现。显然,“选择的武器”是PHPDoc,但是......
我无法真正找到PHPDoc标准的单一规范。有一个维基百科条目列出了一些属性,并且有一个phpDocumentor项目,据说有一个更广泛的字典,但令我困惑的是PHPDoc的权威指南在哪里?是否有单一的标准,或者由所有那些众多的phpDocumentor仿冒产品来扩展PHPDoc“标准”(如果有的话)到它们看起来合适的任何东西。
如果我们假设phpDocumentor是创建和维护PHPDoc标准的地方,事情看起来非常严峻,因为the project's website已经死了近4年了。更令我困惑的是,大约一个月前,phpDocumentor的Pear网站上突然出现了一个1.4.4版本。
我知道这里有更多聪明且知识渊博的伙伴,所以我想知道。与PHPDoc有什么关系。是否有一个权威机构创建标准?它有多可靠?有没有未来,或者我们正在与一个僵尸打交道,所有希望都失去了......
谢谢, IVO
答案 0 :(得分:2)
根据维基百科it's dead。
PhpDoc标签的标准规范曾经是PhpDocumentor文档中列出的标准。但就像我说的那样,它已经死了。由于DocBlox似乎填补了PhpDocumentor留下的空白,我建议使用DocBlox documentation作为您进行PhpDoc评论的基础。
我希望Netbeans 7.1能够引入DocBlox支持,因为它更好。它是PHP 5.3识别并且它是积极维护的。
答案 1 :(得分:1)
这个问题已经有点陈旧了,但为了便于提供信息,我应该补充一点,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回到了行动。 =)
答案 2 :(得分:1)
截至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评论将被多个doc生成器采用。