问题标签 [phpdocumentor2]

我正在使用phpDocumentor2为我的代码编译文档。包含 @throws 和 @uses 的 DocBlocks 并没有完全按照我的预期进行编译。

具体来说，FQSEN 没有在文档输出中呈现。

例如

产生...

请注意，“gatherData()”和“load()”方法名称没有出现在输出中。然而，他们的描述确实如此。

我看到@throws 标签有类似的效果。

这是预期的行为吗？我滥用标签了吗？

这是我第一次使用 phpDocumentor 2，文档根文件夹中的每个文件看起来都很好。

不幸的是，子目录（类、命名空间和包）中的任何内容看起来都不正确或功能不正常，因为它们不引用“../css/template.css”而是“css/template.css”。（与 JS 相同的问题）

我错过了某种配置问题吗？phpDoc 站点上的演示似乎包含对父目录的引用。

提前致谢！

假设我有一些带有 phpdoc 变量的父类：

现在我正在编写子类，它覆盖了这个变量：

所以我的问题是：我应该为 Child 类中的 $variable 编写什么 phpdoc，这样我就不必复制和粘贴变量描述？同样的问题也适用于方法。非常感谢您的帮助。

更新：我在创建 phpdoc 后看到错误后问了这个问题，例如 Child 类中的“No summary for property $variable”。如果我添加此摘要 - 错误就会消失，但无论我在 Child 类中写什么，phpdoc 都会显示来自 Parent 类的描述。我究竟做错了什么？

我在尝试使用phpDocumentor version 2.0.0a12. 使用下面的示例代码，无论我在 {@link 参数} 中尝试什么（例如 /global/foo::bar()、foo::bar、foo::bar() 等），每次都会打印出文本，而不是解析为 html 锚标记。

有没有其他人看到这个？

也许我缺少配置参数？上面使用的配置是：

这可以被认为是PHPDoc inline {@link}（和 Netbeans）的副本，但我不这么认为，因为我是从命令行调用 phpdoc（不使用和 IDE）。任何帮助都非常感谢；）

我正在尝试使用 phpDocumentor Web 界面为 CodeIgniter 项目生成文档。当我尝试解析目录时，我得到一长串看起来像这样的“严格标准”错误

“严格标准：parserTag::getString() 的声明应与 D:\wamp\www\phpdoc\phpDocumentor\DocBlockTags.inc 第 185 行中的 parserStringWithInlineTags::getString($trim = true) 兼容”

“严格标准：phpDocumentorTParser::packageTagHandler() 的声明应与第 2945 行 D:\wamp\www\phpdoc\phpDocumentor\phpDocumentorTParser.inc 中的 Parser::packageTagHandler($word) 兼容”

“严格标准：phpDocumentor_TutorialHighlightParser::setupStates() 的声明应与 D:\wamp\www\phpdoc\phpDocumentor\TutorialHighlightParser.inc 第 527 行中的 Parser::setupStates() 兼容”

谁能告诉我是什么原因造成的，或者它是否与 phpdoc 安装或其他有关？

所以，基本上我有以下设置：

当我尝试使用 phpDocumentor2 对此进行记录时，它会在 B 类的方法 foo() 中显示“这是一些文档”，但是我想说“此文档比 A 类更具体”。在 phpDocumenter 1 中，一切看起来都像预期的那样。那么，这里发生了什么？这是 phpDocumentor2 的新默认行为吗？如果是这样，有没有办法改变它？或者这只是一个错误？

注意：在进行研究时，我经常碰到 {@inheritDoc}，但我希望有完全相反的行为。

phpdoc -d lib/model -t /var/www/html/docs/ --模板响应

生成 html 文档很好。

我已经升级到 PHPDocumentor2 并且找不到输出到 PDF 的命令。1.x 的旧方法在新版本中不起作用。

有人可以告诉我如何执行此操作或将我指向文档。

先感谢您。

我按照 phpdoc.org 上的描述使用 Pear 安装了 phpDocumentor 2。这样做时，我整理了我的评论

除非您说@see class2 Class 2，否则第一个不起作用，而第二个无论如何都不起作用。它只是像它看起来一样打印，而不是将大括号作为内联标签读取。所以，我的问题是 - 我在这里做错了吗？还有其他人遇到类似的事情吗？我下载了 phpDocs 1.x 并没有这个问题，但如果可能的话我想要 phpDocs 2 ..

谢谢！

在http://www.phpdoc.org/的主页上，在http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.quickstart.pkg.html和https://github.com上/phpDocumentor/phpDocumentor2，安装 phpDocumentor 的说明是：

当我这样做时，我看到它已被弃用：

根据http://www.phpdoc.org/docs/latest/for-users/installation/using-pear.html#requirements，说明是：

使用 PEAR 安装 phpDocumentor 的首选方式是什么？

为了记录我的代码，我认为使用 phpDoc 语法是最佳实践，因为那里有几个解析器，并且一些 IDE 会从中创建 IntelliSense。

现在我需要将文档 (API) 放入 word 文件中，但我不知道哪个解析器能够输出 .doc 或类似文件。

我试过 DoxyGen，它输出 .rtf 和 phpDocumentor2，它只能导出到 .html 和 .xml（？）。

有没有办法从 phpDoc 生成 .doc(x) 文件？还是一种简单的方法来获取可以导入到 word 的文档？如果我不必更改 phpDoc 语法，我将不胜感激，因为我的文档很长。

编辑：首选解析器是 phpDocumentor2，因为它支持 PHP 5.3 功能并且比 DoxyGen 更快，但 phpDocumentor2 的功能比不再维护的 phpDocumentor 少，与输出格式相关。

编辑：我试图将 .rtf 文件中的内容复制到 .docx 文件中，但是当我选择“使用目标样式”时，两个 Word 实例都挂起并且不响应。