10

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

4

3 回答 3

5

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

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

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

在 Eclipse PDT 中，您可以调用“外部工具”（参见菜单中的“运行 > 外部工具”）；这将允许您启动 phpdoc 命令（就像您在 CLI 中所做的那样）；但它绝对不像 Zend Studio 提供的那样用户友好——虽然价格也不一样^^

于 2009-07-26T13:57:31.463 回答
2

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

于 2013-09-04T08:28:20.110 回答
1

是的，Zend 中有一个向导可以做到这一点。看看这个简短的指南。

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

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

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

  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 是列表中的第一项，否则选择适当的数字）
于 2009-07-26T13:45:25.830 回答