在Eclipse中使用还是不使用PHPDoc文档生成器？

Question

我使用Eclipse + PDT进行开发。我一直在我的代码中添加phpdoc注释，但实际上从未在Eclipse中生成文档。我该如何操作 - Eclipse中是否有此功能，还是需要外部进行文档生成？

- AlexA

Answer 1

为了生成文档，您应该使用phpDocumentor，它可以作为PEAR包安装。然后，您需要从命令行调用它；实际上我从未在Eclipse PDT中看到过它被调用。一个很好的解决方案是拥有一个持续集成平台（例如使用phpUnderControl），并将phpdoc集成到您的构建配置文件中；这样，每次有人提交代码时都会生成phpdoc（或者每天一次，或者您想要的任何时间）。在Eclipse PDT中，您可以调用“外部工具”（请参见菜单中的“运行>外部工具”）；这将允许您启动phpdoc命令（就像您从CLI中执行的那样）；但它肯定不像Zend Studio提供的那么用户友好 - 当然价格也不同^^

- Pascal MARTIN

---

我使用ant来构建我的php项目，通常有一个文档目标。Eclipse与ant非常兼容。同时你也可以在eclipse中运行phing。 - Lance Rushing

Answer 2

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

- Davide Pastore

---

所以我将路径 C:\wamp\www\apigen.phar 包含在用户变量 PATH 和 System 路径中。但它不起作用！什么也没有输出。 - Suhail Gupta

尝试在此处打开问题：https://github.com/ApiGen/ApiGen/issues - Davide Pastore

我输入了命令 php apigen generate --help，但输出为 Could not open input file: apigen。 - Suhail Gupta

请尝试使用apigen.phar。 - Davide Pastore

相同的 Could not open input file: apigen.phar - Suhail Gupta

Answer 3

是的，在Zend中有向导可以完成这个操作。请查看这个简要指南。

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

1. 选择Run->External Tools->External Tools Configurations...
2. 在左侧窗格中，选择Program，然后选择新图标（窗格上方最左侧的图标）。
3. 在右侧窗格中，选择Main选项卡。
4. 在Name字段中输入generate_doc。
5. 在Location字段中输入phpdoc cli工具的路径。
6. 在Arguments字段中输入任何所需参数，例如对于当前项目输入${project_loc}。
7. 要运行外部配置，请选择Run。

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

1. 从菜单栏中选择“外部工具”图标外部工具图标http://help.eclipse.org/ganymede/topic/org.eclipse.cdt.doc.user/images/icon%5Fext%5Ftools.png，然后单击“generate_doc”
2. 选择“运行”->“外部工具”->“generate_doc”
3. 按下Alt+R、E、1（假设generate_doc是列表中的第一项，否则选择适当的数字）

- Rich Seller

---

谢谢，但我正在使用普通的Eclipse + PDT，显然没有这样的选项。 - AlexA