3

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

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

我已经尝试将 .pkg 示例文件移动到整个文件结构中，在子文件夹中使用与代码中引用的包相似的名称.. 我真的很茫然 - 如果有人可以解释他们放置的位置.pkg 和其他 DocBook 文件与他们正在记录的代码以及它们如何触发 phpdoc 对其进行格式化有关，我将不胜感激，我目前正在使用它：

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

4 回答 4

3

我没想到会回答我自己的问题，但是经过 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 的界面也发生了相同的行为，所以它是一个内部的问题。我最初的尝试应该有效，但我不会联系开发人员并引起他们的注意。

问题解决了。

于 2009-08-10T09:36:18.443 回答
1

你读过这个吗？

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

于 2009-08-06T23:36:40.083 回答
0

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

通常情况下，我已经看到了关于未创建教程的另外两个问题。一，教程目录不是 phpDocumentor 所期望的。第二，执行中不包含实际的 PHP 代码文件。我记得在手册中专门针对这两种情况添加了措辞。

于 2009-11-22T15:08:54.493 回答
0

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

不工作：

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

在职的：

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

希望这可以解决其他人的问题！

于 2011-06-16T08:01:29.040 回答