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

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

我正在使用Eclipse

我已经通过PEAR在OSX机器上安装了phpDocumentor

我可以从我的php类运行并自动生成代码

它不会格式化教程-我找不到解决方案

我尝试将.pkg示例文件移动到整个文件结构中的所有子文件夹中，使用与代码中引用的包类似的名称。。我真的不知所措-如果有人能解释一下他们将.pkg和其他DocBook文件放在哪里，以及它们是如何触发phpdoc对其进行格式化的，我将不胜感激，我现在正在使用：

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

你读过吗

---

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

我没想到会回答我自己的问题，但经过两天的心痛和一个周末的实验，似乎这就是问题所在：

本教程和我的示例应该可以使用，但是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的一个bug，基于web的界面也出现了同样的行为，因此这是一个内部问题。我最初的尝试应该是有效的，但没有成功。我会联系开发人员并引起他们的注意

---

问题已解决。

是的，您使用双引号可能会中断phpDocumentor的内部运行时参数解析，导致

-d/path/to/code/classes

成为一个arg/value对，而不包括

/path/to/code/docs/tutorials

作为附加目录值

---

通常情况下，我会看到关于教程的另外两个问题没有被创建。第一，教程目录不是phpDocumentor所期望的。第二，执行中不包含实际的PHP代码文件。我记得在手册中特别添加了详细说明。

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

不工作：

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

工作：

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

---

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

是的，我在文档中读了那一页，很多次。它建议使用tutorials/package/package.pkg——我在大约4-5个地方尝试了这个方案——所有这些都没有任何区别。我还尝试只使用包的单独名称，因为我无法使其工作。最初我把它设置为：/path/to/docs/tutorials/package/package.pkg然后：/path/to/code/tutorials/package/package.pkg然后：/path/to/tutorials/package/package.pkg然后：/path/to/docs/tutorials/package.pkg我想可能还有2-3次不同的尝试。这很奇怪。你检查过文件的权限了吗？你知道该文件应该有什么权限吗？我没有检查过，并且想象它只需要用户可读-我可以尝试以root用户身份运行该命令，我会检查。我正在使用位置：trunk/tutorials/package/package.pkg并在命令行中包含-d trunk/tutorials/。结果，我得到了：教程/扩展文档解析阶段-完成-所以什么也没发生。如果输出文件夹中的docbook内容有效，我希望在哪里看到它？想知道这是否与.ini文件有关-无法理解为什么.pkg/.proc在生成文档时无法被识别。。。