有比PHPDoc更好的东西吗?

24

有人在记录 PHP 代码时使用除 PHPDoc 之外的其他工具吗? 是否有任何读取相同文档语法但提供更丰富输出的工具?


请明确“更丰富的输出”。否则很难给出精确的答案。 - Paweł Hajdan
1
你在5.3版本中遇到了什么问题?此外,通过PHP命令行版本(如果需要,使用自定义ini文件进行更大的内存分配)运行文档生成器可能会解决内存问题。 - John Parker
据我所了解,phpDocumentor不支持命名空间。内存问题是他们肯定尝试过的,但我可以再确认一下。 - user256162
@user256162 它可以在PHP 5.3中工作,但所有类都进入默认包。我希望它能像包一样处理命名空间。有人成功做到了吗? - umpirsky
9个回答

19

我也会选择使用Doxygen。

以下是几个原因:

  • 与phpdoc标签和其他流行的标签兼容:具有互操作性
  • 适用于各种编程语言:更好的投资时间
  • 有替代语法:可以选择适合您的注释样式
  • 在高级格式化/标记/元数据方面非常高效
  • 有一个独立于任何IDE的GUI和一个eclipse插件

而且,它仍然是免费的、跨平台的,并且是开源的 :-)

学习起来很容易,但比phpdoc难度更大,因为功能更加丰富。


8

7

除了phpDocumentor之外,另一个选择是支持PHPDoxygen文档。


你知道Doxygen的内存占用比phpDocumentor小吗?谢谢! - user256162
1
回答自己的问题,Doxygen 能够指向比 phpDocumentor 更大的代码库部分。 - user256162

5

3

我没有在PHP中使用过它,但是doxygen声称支持该语言。


3

ApiGen

http://apigen.org/

ApiGen支持PHP 5.3的命名空间、包、文档之间的链接、与PHP标准类和一般文档的交叉引用,创建高亮源代码以及实验性地支持PHP 5.4 traits。

DocBlox

http://www.docblox-project.org/

DocBlox是一个PHP 5.3兼容的API文档生成器,旨在适用于各种规模的项目和持续集成。它能够完全解析和转换Zend Framework 2。


http://apigen.org很棒,我一直在使用它。它支持命名空间,并且输出的代码也很好看。这是我的ant配置:`<target name="apigen" description="使用apigen生成API文档 -- http://apigen.org/"> <exec executable="apigen.bat"> <arg value="--source" /> <arg path="${basedir}/lib" /> <arg value="--destination" /> <arg path="${basedir}/build/docs" /> </exec>` - Jujhar Singh

2

+1 for PHPDoctor - 它的表现非常出色。 - Jonathan Chan

2
我也在使用Doxygen - 你会很快熟悉各种关键词,它们有点自解释。 ;) RubyDoc 也不错,我特别喜欢rdocs的布局。

1
如果您需要为 PHP 5.3+ 编写文档,例如使用命名空间,Ted Kulp 的 PHPDoctor 分支 可能是您的答案。

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接