Question

我正在尽我所能让phpdocumentor允许我使用DocBook教程格式来补充它创建的文档：

我正在使用Eclipse
我在OSX机器上通过PEAR安装了phpDocumentor
我可以运行并从我的php类自动生成代码
它不会格式化教程 - 我找不到解决方案

我已经尝试将.pkg示例文件移动到整个文件结构中，在子文件夹中使用与代码中引用的包类似的名称。我真的不知所措 - 如果有人可以解释WHERE他们将.pkg和其他DocBook文件与他们正在编写的代码相关联，以及它们如何触发phpdoc格式化我会很感激，我现在正在使用它：

phpdoc -o HTML:Smarty:HandS
-d "/path/to/code/classes/", "/path/to/code/docs/tutorials/"
-t /path/to/output

Answer 1

我没想到会回答我自己的问题，但经过2天的心灵弯曲和周末的实验后，这似乎是问题所在：

本教程和我的示例应该可行，但 似乎在phpdoc解释切换值的方式上存在一个小缺陷 。这是我一直在使用的：

phpdoc -o HTML:Smarty:HandS
-d "/path/to/code/classes/", "/path/to/code/docs/tutorials/"
-t /path/to/output

但是，如果您使用以下内容：

    phpdoc -o HTML:Smarty:HandS 
-d /path/to/code/classes/, /path/to/code/docs/tutorials/
-t /path/to/output

它将正确格式化您的教程和扩展文档，我所做的只是删除目录路径周围的双引号。单引号根本不起作用 - 因为如果没有空格，phpdoc本身用双引号包装目录......这看起来像phpdoc的一个错误，并且基于Web的界面也发生了相同的行为，因此它是一个内部问题。我最初的尝试应该有效，但我不会联系开发人员并提请他们注意。

问题解决了。

Answer 2

您是否阅读过this？

它建议使用以下路径方案： tutorials / package / package.pkg 其中package是包的名称，你是这样做的吗？

Answer 3

是的，你使用双引号可能会抛弃phpDocumentor的内部运行时参数解析，导致-d /path/to/code/classes成为一个arg / value对，而不包括/path/to/code/docs/tutorials作为附加目录值。

通常情况下，我已经看到围绕未创建教程的其他两个问题。一，教程目录不是phpDocumentor所期望的。二，执行中不包含实际的PHP代码文件。我记得特意在手册中添加了措辞for these two scenarios。

Answer 4

我在使用.ini进行配置时遇到了同样的问题，但问题是我在逗号和目录之间放了一个空格，这导致目录没有与-d参数“链接”

不工作：

directory = {$lib}/Question,{$lib}/Error, {$path}/docs/tutorials

工作：

directory = {$lib}/Question,{$lib}/Error,{$path}/docs/tutorials

希望这能为其他人解决问题！

如何创建phpdoc教程/扩展页面以补充注释代码

4 个答案: