我以前从来不太关心记录我的代码,但最近我开始从事一个开源项目,并且出现了需求。显然“首选武器”是PHPDoc但是..。
我真的找不到PHPDoc标准的一个规范。维基百科上有一个列出了一些属性的条目,还有一个phpDocumentor项目,据说它有一本更广泛的字典,但让我困惑的是,PHPDoc的权威指南在哪里?有没有一个单一的标准,或者是所有那些无数的phpDocumentor山寨货将PHPDoc“标准”(如果有的话)扩展到他们认为合适的任何东西。
如果我们假设phpDocumentor是创建和维护PHPDoc标准的地方,事情看起来相当严峻,因为the project's website已经死了大约4年了。更让我困惑的是,大约一个月前,在phpDocumentor的梨网站上突然出现了一个1.4.4版本。
我知道这里有很多更聪明更有见识的人,所以我很想知道。PHPDoc是怎么回事?是否有一个单一的权威机构创建该标准?它有多可靠?有没有未来,或者我们正在对付一个僵尸,所有的希望都破灭了……
谢谢,伊沃
发布于 2012-09-11 21:19:58
这个问题已经有点陈旧了,但为了提供信息,我应该补充一句,DocBlox是与PhpDocumentor合并的。
宣布phpDocumentor 2-新旧(phpDocumentor)和新(DocBlox)的合并。
在phpDocumentor的第一个alpha版本(2.0.0a1)中,新的“响应式”默认模板采用了新的页面布局,以及原始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重回正轨。=)
发布于 2012-01-02 18:40:06
根据维基百科it's dead。
过去,PhpDocumentor的文档中列出了PhpDoc标签标准的规范。但就像我说的它已经死了。由于DocBlox似乎正在填补PhpDocumentor留下的空白,我建议您使用DocBlox documentation作为做PhpDoc评论的基础。
我希望Netbeans 7.1能引入对DocBlox的支持,因为它好多了。它支持PHP5.3,并得到了积极的维护。
发布于 2014-09-01 06:14:47
从2013年8月开始,PHP Framework Interoperability Group开始为PHPDoc编写正式规范。PHPDoc的建议标准,当前的草案PSR5:https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md
当前的草案更新了规范,以解决PHP 5.3+,以及发生的其他更改。我相信人们的期望是,php注释的这个标准将在多个文档生成器中被采用。
https://stackoverflow.com/questions/8697701
复制相似问题