问题标签 [phpdoc]

有没有人使用其他任何东西来记录他们的PHP代码PHPDoc? 是否有任何工具可以读取相同的文档语法但提供更丰富的输出？

我想运行一个为我的 php 项目构建文档的脚本。它基本上只是使用 wget 来运行 phpdoc。

一个文件可以属于多个子包吗？例如：

谢谢！

我正在尝试在我的 WAMPServer 设置上运行 PHPDocumentor。它运行良好，但我想排除某些目录，例如不包含我自己的代码的 \sqlbuddy\。具有讽刺意味的是，PHPDocumentor 似乎忽略了我的 --ignore 开关。我尝试了几种表达相同事物的方法，但结果相同。下面是我运行它的命令：

非常感谢。

我想知道如何在 phpdoc 评论中转义 phpdoc 评论。

例如，我将如何写这个：

显然上面的例子是行不通的。

我尝试用 * 替换星号，但它会很好地打印“*”...

有没有一种直接的方法来获取 docbook 内容并将其转换为 DokuWiki 内容？到目前为止，我只找到了DokuWiki 插件，它可以解释文档内容并将其输出为 XHTML，但每次页面加载都会发生这种情况。

我想找到一种方法将 docbook 内容直接转换为 DokuWiki 的本机格式语法，因此我只需解释一次。有任何想法吗？

因此，在 PHPDoc 中，可以@var在成员变量声明上方指定以提示其类型。然后是 IDE，例如。PHPEd 将知道它正在使用什么类型的对象，并将能够为该变量提供代码洞察力。

这很有效，直到我需要对一组对象做同样的事情，以便以后在遍历这些对象时能够获得正确的提示。

那么，有没有办法声明一个PHPDoc标签来指定成员变量是一个SomeObjs的数组呢？@var例如，数组是不够的，而且@var array(SomeObj)似乎无效。

我今天第一次尝试使用 PHPDoc，很快就遇到了问题。

对于每 1 行变量声明，我至少有 5 行注释。例子：

当然，回报是不错的——但这会将一个 10 行的配置文件变成一个 60 行的文件。需要我永远填写，而且我还不相信它比简单的单行增加了那么多。

它也给我的工作流程带来了麻烦。一切都很好，直到我需要进行彻底的改变。有了我记录良好的文档块，突然之间我不再需要重构我的代码，但我需要重新编写所有这些繁琐的细节。等到你说的最后？哈哈！那么文档将永远不会发生。

最重要的是 - 它迫使我在我的代码中间使用 C 风格的 /**/ 注释。这让我在开发过程中发疯，因为它剥夺了按需注释掉大块的能力。现在要注释掉一大块代码，我需要提取类似 :range,s/^/#/ 的内容；然后稍后撤消它。恼人的！

长话短说 - 我喜欢 PHPDoc，我喜欢有据可查的代码 - 但是每行代码 5 行注释实在是太多了！. 有我缺少的功能吗？这是个常见的问题吗？

背景：

PHPDoc ( http://www.phpdoc.org/ ) 是一个出色的工具，用于从文件中的注释中提取类或方法的 html 文档。添加 PHPDoc 注释还有其他优点 - 如果您使用 Zend 或 Netbeans 之类的 IDE，它将使用 PHPDocs 向您显示自动完成提示。

大多数问题跟踪器都有一个功能，您可以使用特殊注释提交到您的版本控制系统，它会自动将该提交链接到该问题。

所以这就是我想要的系统：我提交了一些带有特殊注释的代码，我的问题跟踪器将它链接到一个问题。然后它查看提交并计算出我更改了​​哪些方法和类。然后它说“如果您正在寻找有关此问题的文档，请尝试 PHPDoc 的这些位：ClassX.FunctionY, ClassZ.VariableP”。它会自动将用户指向可能相关的文档。我认为这将是一个很棒的功能。

问题：

因此，缺少的部分是获取 PHP 代码差异，并计算出哪些类和方法发生了变化。有人对一些可以做到这一点的代码有任何指示吗？

在此先感谢，詹姆斯

我基本上是 PEAR（和 PhpDocumentor）的新手；我使用 PEAR CLI 安装了 PhpDocumentor，一切似乎都很顺利......直到我开始使用它，此时我收到以下错误：

我在网上找不到任何有关该错误的信息，因此我再次通过命令行卸载/重新安装而没有错误，但我遇到了同样的问题。我忽略了什么吗？正如我所说，我对 PEAR 很陌生 :)

谢谢。D