问题标签 [phpdocumentor2]

我正在尝试在我们的团队开发环境中自动构建文档，因此我们决定使用 phpDocumentor(2.7.0) 并触发它在 SVN 提交后重建文档。

我做了一个触发器，但我很确定每次执行时都会重新构建所有文档，因为即使我只提交一个修改过的文件，phpdoc 命令的持续时间几乎与文档初始构建时一样。

所以我的想法是只重建那些文件的文档，在提交中更改。有没有可能这样做？我查看了 phpDoc 和 Google 的文档，但没有找到。

我很难让 phpDocumentor 2 正常工作。

我有几个程序风格的文件，必须记录在案。我发现这样做的唯一方法是使用页面级 docblocks，但似乎它们在 phpDocumentor 版本 2 中不再正常工作。

stackoverflow 上的一个相关问题显示其他人在相同的问题中运行。在这个问题中，有两个建议：

1. 将 a 添加namespace到应记录的文件中
2. 从phpDoc 问题 910 开始，使用模板abstract或new-black

不幸的是，我无法找到工作。

1. 当我添加命名空间时，命名空间本身会显示在文档中，但不会显示在文档块的内容中。
2. 当我使用 phpDoc 2 的 phar 版本选择另一个模板（我尝试过zend，abstract和）时，我得到了错误。显然这是一个已知问题。new-blackPHP Warning: XSLTProcessor::transformToUri(): No stylesheet associated to this object in phar

编辑：

我又进了一步。我安装了 PEAR 版本的 phpDocumentor，并尝试了每个可用的模板。但我还远未达到目标：生成文档中的页面级文档块。
模板分为两类：

• clean, responsive,responsive-twig和old-ocean: 它们不会在生成的文档中输出页面级文档块。
• abstract,new-black和zend: 他们有一个文件部分的文档，显示预期的文件级文档。但是它们错过了几个资源（.js 文件和图像），因此它们看起来都一样，并且不能正常工作（导航窗格没有展开-折叠行为）。我查看了他们的 git 存储库，甚至那里的文件似乎也丢失了。

在这一点上，我只是想知道我是否正在寻找正确的方向：由于 phpDocumentor 2 中的主要回归和错误，不可能有一个显示文件级 docblocks 的文档的文档。

如果我真的走错了路，请建议我如何从我的 PHP 项目中获取有价值的文档。如果我走在正确的轨道上，请帮助我了解我缺少的难题中的重要部分。

我最近创建了一个类来创建 HTML 元素。我决定使用魔术方法 __get 和 __call，而不是为每个现有的 HTML 元素和属性创建一个方法。所以用我的代码我基本上可以做到这一点：

等等

但既然我决定保持这种“魔法”和简单，我也可以这样做：

$signUpForm->insert->magic->trick('rabbit')->accessory('hat')这将导致：

这一切都很好，因为在我看来，它减少了很多样板代码，并且完全符合我的需要。我不想要一个类来强制执行 HTML 标准，我想要一个类来促进 HTML，因为你知道如何使用它（老实说，这样做的代码很小）

所以我的问题是，考虑到这个类可以接受任何未定义的属性或方法，有没有办法在 PHPDoc 中指定这种行为？我尝试了以下没有任何运气：

我不知道这是否只是 PHPStorm 的事情，但我在任何地方都找不到任何类似的场景......

另外，如果您想知道我为什么要这样做，它是为了跟踪我的 PHP 代码中的某些 HTML 方面（例如，在表单中声明的​​ ID，或在表单中的元素）。这可以让我在将 HTML 发送给最终用户之前对其进行查看。

我正在尝试记录一个示例文件：

我在 CLI 中运行：

它工作正常，但是当我在这里查看我的 html 输出时：

类和方法 setupDataConnection 根本没有记录。

这是我看到的屏幕：

谁能解释我做错了什么？

我想知道是否可以使用 phpDocumentor 从方法内部获取注释行。我不仅在方法块中注释，而且在它自身的方法内部也有很多注释。

作曲家依赖声明它没有 php-xsl。我正在尝试安装 phpdocumentor/phpdocumentor，但由于需要，它不会让我安装。所以现在我正在尝试安装要求，我得到了这个：

PHP信息：

还是它可能告诉我我需要 ext-xsl？那是什么？还是说我需要 PHP xsl？

这与标记的 dup 帖子不同，请参阅下面的评论以了解原因。

如何在laravel 5中使用 phpdocumentor除了通过 CLI 之外，还有什么简单的方法可以生成文档

使用 phpDocumentor 生成文档时，如果 @param，@return 值是您项目中的一个类，例如：

phpdoc 会自动将 My\Awesome\Class 链接到该类的文档。我试图弄清楚是否有办法让它链接到供应商类的文档，即：

链接到http://www.doctrine-project.org/api/common/2.5/class-Doctrine.Common.Collections.ArrayCollection.html。我能想到的最接近的解决方案是让 phpdoc 也为所有供应商库生成文档，这似乎不太理想。

来自http://www.phpdoc.org/docs/latest/guides/types.html#primitives

似乎 PHPDoc 只识别 type float。

看到 PHP 是如何用 C/C++ 编写的，我想知道为什么它不double作为一种类型提供。

我想为我的 PHPDoc 块提供指向方法参数的现有文档的链接。所以，我使用了@link标签并将 URL 放在它后面。问题是 URL 太长，在我的 IDE 中看起来不太好。你会建议什么来管理这种情况，我的意思是让 DocBlock 看起来很愉快或以某种方式缩短 URL？URL 指向我们的内部 wiki，其中包含俄语符号，使其更长。我们使用 PHPStorm 和 NetBeans 作为主要 IDE。