Eclipse内外的PHPDoc文档生成器？

Question

我正在使用Eclipse + PDT进行开发。我一直在我的代码中添加phpdoc注释， 但实际上从未在Eclipse中生成过结果文档。我该怎么做 - Eclipse中是否有一些功能，或者应该在外部完成doc生成？

Answer 1

要生成文档，您应该使用phpDocumentor，它可以作为PEAR包安装。

然后，你必须从命令行调用它;实际上，我从未见过从Eclipse PDT调用它。

一个很好的解决方案是拥有一个持续集成平台（例如，使用phpUnderControl），并在构建配置文件中集成到phpdoc的创建;这样，每当有人提交（或每天一次，或者每当你想要^^）时，都会生成phpdoc。

在Eclipse PDT中，您可以调用“外部工具”（请参阅​​菜单中的“运行＆gt;外部工具”）;这将允许您启动phpdoc命令（就像您从CLI那样）;但它绝对不像Zend Studio所提供的那样友好 - 不是同样的价格，尽管^^

Answer 2

另一个生成文档的好工具是ApiGen。它不需要与PEAR一起安装（但包括它），它可以像独立的包一样使用。

Answer 3

是的，有一个向导可以在Zend中执行此操作。看看这个brief guide。

或者，您可以创建外部启动配置以调用标准phpDocumentor。

1. 选择运行 - >外部工具 - >外部工具配置...
2. 在左侧窗格中，选择“程序”，然后选择新图标（窗格上方最左侧的图标）。
3. 在右侧窗格中，选择主选项卡。
4. 在名称：字段中输入generate_doc。
5. 在位置：字段中输入phpdoc cli工具的路径。
6. 在Arguments字段中输入任何必需的参数，例如对于当前项目输入$ {project_loc}。
7. 要运行外部配置，请选择“运行”。

要重新运行配置，您有几个选择：

1. 从菜单栏external tools icon http://help.eclipse.org/ganymede/topic/org.eclipse.cdt.doc.user/images/icon%5Fext%5Ftools.png"中选择外部工具图标，然后点击generate_doc
2. 选择Run-＆gt; External Tools-＆gt; generate_doc
3. 按Alt + R，E，1（假设generate_doc是列表中的第一项，否则选择合适的数字）