【发布时间】：2010-11-14 03:40:06
【问题描述】：
我正在使用 Eclipse + PDT 进行开发。我一直在我的代码中添加 phpdoc cmets， 但实际上从未在 Eclipse 中生成结果文档。我应该怎么做 - Eclipse 中是否有一些功能，或者文档生成应该在外部完成？
【问题讨论】：
标签： php eclipse documentation phpdoc
【发布时间】：2010-11-14 03:40:06
【问题描述】：
要生成文档，您应该使用phpDocumentor，它可以作为 PEAR 包安装。
然后，你必须从命令行调用它；实际上，我从未见过从 Eclipse PDT 调用它。
一个很好的解决方案是拥有一个持续集成平台（例如使用phpUnderControl），并在构建配置文件中集成到 phpdoc 的创建；这样，每次有人提交 （或每天一次，或任何时候 ^^） 都会生成 phpdoc。
在 Eclipse PDT 中，您可以调用“外部工具”（参见菜单中的“运行 > 外部工具”）；这将允许您启动 phpdoc 命令（就像您在 CLI 中所做的那样）；但它绝对不像 Zend Studio 提供的那样用户友好——虽然价格也不一样^^
【讨论】：
-
我使用 ant 来构建我的 php 项目，并且通常有一个 doc 目标。 Eclipse 与 ant 配合得非常好。您还可以从 eclipse 运行 phing。
另一个生成文档的好工具是ApiGen。它不需要与 PEAR 一起安装（但包含它），它可以像一个独立的包一样使用。
【讨论】：
-
我们如何为 windows 安装
ApiGen？我下载了phar包，但不知道如何继续。 -
@SuhailGupta 看看这里：github.com/ApiGen/ApiGen
-
所以我将路径
C:\wamp\www\apigen.phar包含在用户变量PATH和System路径中。但它不起作用！什么都不打印。 -
尝试在这里打开一个问题：github.com/ApiGen/ApiGen/issues
-
我输入命令为
php apigen generate --help，输出为Could not open input file: apigen
是的，Zend 中有一个向导可以做到这一点。看看这个brief guide。
或者，您可以创建一个外部启动配置来调用标准phpDocumentor。
- 选择运行->外部工具->外部工具配置...
- 在左侧窗格中，选择“程序”，然后选择新图标（窗格上方最左侧的图标）。
- 在右侧窗格中，选择“主”选项卡。
- 在名称：字段中输入 generate_doc。
- 在 Location: 字段中输入 phpdoc cli 工具的路径。
- 在“参数”字段中输入任何必需的参数，例如对于当前项目输入 ${project_loc}。
- 要运行外部配置，请选择运行。
要重新运行配置，您有几个选择：
- 从菜单栏中选择外部工具图标external tools icon http://help.eclipse.org/ganymede/topic/org.eclipse.cdt.doc.user/images/icon%5Fext%5Ftools.png"，然后单击generate_doc
- 选择运行->外部工具->generate_doc
- 按 Alt+R、E、1（假设 generate_doc 是列表中的第一项，否则选择适当的数字）
【讨论】：
-
谢谢，但是我用的是普通的Eclipse + PDT，显然没有这样的选择。