【问题标题】:How to generate phpDoc documentation for a specific folder in Netbeans IDE?如何为 Netbeans IDE 中的特定文件夹生成 phpDoc 文档?
【发布时间】:2011-08-10 23:54:17
【问题描述】:

由于我们需要在项目根目录中集成 Zend 框架,并且生成该文档将无用且需要很长时间,我想为 application中的所有文件生成文档> 仅文件夹。

有谁知道我如何通过 Netbeans 7.0 界面为特定项目文件夹生成文档?

更新: 到目前为止我发现的最好的方法是:

从 netbeans 打开终端窗口,然后输入:

sudo phpdoc -d public_html/yoursite.dev/application/ -t public_html/yoursite.dev/docs/

更新 2 假设我们的 Zend 库在 projectrootname/library/Zend 中,我们也可以尝试,通过转到:Tools > Options > Php > PhpDoc 并放置以下内容:

/usr/bin/phpdoc -i library/Zend/ -o HTML:frames:earthli

至少对我来说,这似乎不起作用,因为当我尝试生成文档时,我在输出窗口上显示权限错误问题。

谢谢

【问题讨论】:

  • 忽略开关呢?我没有使用 Zend 框架,但是我使用了忽略开关来忽略其他第三方库。 manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/…
  • @Paul:我现在不关心它,看起来不错,但为了做到这一点,我们必须为每个项目更改 netbeans phpdoc 命令,忽略该项目特定的 zend库文件夹。我相信不是很实用。
  • 我的印象是 PHPDoc 命令是 Netbeans 中的全局选项,而不是每个项目。忽略开关允许使用模式,所以它应该类似于 /Zend。如果我不正确并且选项是每个项目的,我建议直接编辑项目文件(project.properties)。在对 PHPUnit 选项进行许多更改之前,我已经这样做了(只要确保 Netbeans 已关闭并且您当然要备份项目文件)。
  • @Paul - 实际上,当您编辑 PHPDoc 配置时,您是在与项目无关的地方进行的。但为了生成并实际使用该代码,您必须在项目名称上方的上下文菜单下执行此操作。由于我们想忽略 Library/Zend,并且所有 Zend 项目都将具有这种结构,所以也许正如您所说的那样可以做到。我会试一试。 (与此同时,我创建了一个 bash 进程来执行有关问题的命令)。您可以很好地提供您的答案,因为我相信如果它有效,它将符合提议。

标签: zend-framework netbeans phpdoc


【解决方案1】:

-d/--directory 选项 [1] 应该用于突出显示您希望 phpDocumentor 开始读取的最高级别代码目录。如果您的 Zend 文件夹位于或高于您的应用程序目录的级别,那么仅使用 --directory /path/to/application 应该有助于您仅记录您的应用程序代码。

如果您的 Zend 文件夹在您的应用程序中的某个位置(例如,在您的应用程序的 ./lib 文件夹中),那么您可以使用 -i/--ignore 选项 [2] 告诉 phpDocumentor 它将看到但应该看到的任何目录忽略,--ignore *zend*。请注意,格式化您的忽略值可能很棘手,因此请参阅手册中的示例。另外,请注意,当 phpDocumentor 运行时,您看到这些被忽略的文件夹和文件在输出中列出... phpDocumentor 通过不为这些文件生成文档来“忽略”它们。但是,它仍然需要解析它们,以防这些对象在确实记录在案的文件中被引用。

[1] -- http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.directory

[2] -- http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.ignore

【讨论】:

  • 如果我们转到:工具 > 选项 > Php > PhpDoc 并输入:/usr/bin/phpdoc -i library/,Zend -o HTML:frames:earthli 我们将使其正常工作。请注意那里的逗号,用于不同的目录。致谢:stackoverflow.com/questions/362328/…
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多