2009-07-26 73 views
10

我正在用Eclipse + PDT进行开发。我一直在将phpdoc注释添加到我的代码中,但实际上从来没有在Eclipse中生成结果文档。我该怎么做 - Eclipse中是否有一些功能,或者是否应该在外部完成文档生成?PHPDoc文档生成器进出Eclipse吗?

回答

5

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

然后,你必须从命令行调用它;实际上,我从来没有见过从Eclipse PDT调用它。

一个很好的解决方案是拥有一个持续集成的平台(例如使用phpUnderControl),并集成到您的构建配置文件中创建phpdoc;这样,每当有人提交(或每天一次,或者只要你想要^^),就会生成phpdoc。在Eclipse PDT中,您可以调用“外部工具”(请参阅​​菜单中的“运行>外部工具”)。这将允许你启动phpdoc命令(就像你从CLI执行的一样);但它明确地不像Zend Studio提供的那样用户友好 - 不是同样的价格,尽管^^

+0

我用ant来构建我的php项目,并且通常有一个doc目标。 Eclipse与蚂蚁玩得很好。你也从日食中运行phing。 – 2009-08-13 03:27:16

1

是的,有一个向导在Zend中这样做。看看这个brief guide

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

  1. 选择运行 - >外部工具 - >外部工具配置...
  2. 在左侧窗格中,选择程序,则新图标(最左侧的图标窗格的上方)。
  3. 在右侧窗格中,选择Main选项卡。
  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. 选择运行 - >外部工具 - > generate_doc
  3. 按Alt + R,E,1(假设generate_doc是列表中的第一项,否则选择合适的编号)
+0

谢谢,但我使用普通的Eclipse + PDT,显然没有这样的选项。 – AlexA 2009-07-26 13:52:19

2

另一个生成文档的好工具是ApiGen。它不需要使用PEAR进行安装(但包含它),它可以像独立软件包一样使用。

+0

我们如何为windows安装`ApiGen`?我下载了`phar`软件包,但不知道如何继续。 – 2016-01-28 15:20:38