问题标签 [phpdocumentor2]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
682 浏览

php - PhpStorm 7 @method 错误或我错误地使用 phpDocumentor 注释?

我不知道这是我的错误(错误的 phpDocumentor 注释)还是一个错误。有人遇到这个问题吗?

如您所见,链接(即$f->baz()->baz())没有代码完成,并且boolean类型是命名空间的:

问题 1 问题 2

0 投票
2 回答
463 浏览

php - Symfony2 安装 phpDocumentor

我想将 phpdocumentor 安装到我的 Symfony 2.4 项目中,所以我在 composer.json 中添加了这两行:

当我执行 php composer.phar 更新时,我有这些错误:

虽然我在我的 php 扩展中安装了 php_xsl?!!谢谢你。

0 投票
1 回答
443 浏览

phpdoc - PhpDocumentor 2 在“将分析的项目转换为工件”时卡住了

我刚开始使用 PhpDocumentor 2。一切似乎都正常,所有文件都已处理,但是当它到达这个“将分析的项目转换为工件”时,它会卡住几个小时并且永远不会完成。

我想知道以前是否有人遇到过这个问题,如果你能指出我正确的方向来解决它,那就太棒了

谢谢!

0 投票
2 回答
1518 浏览

phpdoc - phpDocumentor - 更改模板

我正在使用来自http://phpdoc.org的 phpDocumentor 。

试图更改模板“响应式树枝”让我抓狂。我所做的任何更改

被完全忽略。但是,如果我重命名文件并运行 phpdoc,则会收到找不到该文件的错误。然后我清空了这个文件(0 字节)——phpdoc 命令运行良好,产生与原始文件完全相同的输出。

在所有尝试之间,我总是删除整个输出目录以确保不涉及缓存。

我不明白模板如何以及从何处获取信息,关于模板的文档在 phpDocumentor 的网站上不可用。在谷歌上搜索也没有帮助。

有什么提示吗?我真的很感激。谢谢。

0 投票
2 回答
1896 浏览

php - 在 PhpDocumentor 2 中使用 @package 而不是命名空间

我有一个大型代码库,我正在尝试为其生成分层文档。该项目不使用命名空间,而是使用 @package。

我刚刚尝试使用 phpDocumentor2 从以下文件生成文档作为测试:

虽然根据文档@package JustAn\Example 应该等同于命名空间 JustAn\Example,但我发现情况并非如此。

当我使用命名空间时,生成的文档是这样的:

命名空间版本

当我使用@package 符号时,结果看起来像这样(即使它识别包符号 - 这显示在类的完整详细信息页面上):

包符号版本

我正在寻找一种方法来获得分层结果,而无需重写代码以使用“真实”命名空间。

0 投票
0 回答
72 浏览

php - phpDocumentor2 - 更新选择性类

我是 phpDocumentor2 的新手。我想知道是否可以只更新特定文件而不更新整个目录。请参考下面的示例目录结构。

是否可以选择只更新 Classes/Controller/Class_B.php 还是必须更新 Classes/ 下的所有内容?如果可能,是否还有任何选项可以将新的类文件添加到现有文档中?

0 投票
1 回答
3927 浏览

php - PhpDocumentor:如何选择模板?

最近我遇到了 PhpDocumentor。它看起来像一个很好的文档工具。我想使用 'responsive-twig' 作为 phpDocumentor 附带的模板。我试过了;

  • --template="responsive-twig" 在带有 phpdoc 的命令行中,它说“错误:遇到未知的命令行选项“--template”,请使用 phpdoc -h 寻求帮助”

  • 在 /usr/share/php/phpDocumentor/data/phpdoc.tpl.xml 中将 'template' 标签的 'name' 属性更改为 'responsive-twig',默认为 'clean'

  • 在 /usr/share/php/phpDocumentor/phpdoc.dist.xml 中将 'template' 标签的 'name' 属性更改为 'responsive-twig'

但是我无法更改默认模板。

我已经通过 PEAR 安装了 phpDocumentor。我有三个 phpDocumentor 目录。/var/www 中的一个和 /usr/share/php 中的另外两个('phpDocumentor' 和 'PhpDocumentor')。

/usr/share/php/phpDocumentor/data/templates 下有一个“responsive-twig”文件夹。

请帮忙!

0 投票
1 回答
3019 浏览

php - PHPDocumentor @example 用法

我似乎无法理解如何让 PHPCocumentor2@example标签正常工作。

我正在尝试解析单个文件。我的工作目录是/home/developers/domains/example.com并且我正在尝试解析(相对于我的工作目录)simplesamlphp/modules/example/lib/Auth/Process/RoleTrigger.php。这个类文件有一个 DocBloc,看起来像:

当我运行命令以最大详细度(phpdoc -f simplesamlphp/modules/example/lib/Auth/Process/RoleTrigger.php -t httpdocs/test -vvv)解析此文件时,PhpDoc 表示当前项目根目录为/home/developers/domains/example.com/simplesamlphp/modules/example/lib/Auth/Process/,因此,根据文档,这表示示例文件RoleManager.usage.example.php应位于解析文件的同一目录级别,或在examples当前项目根目录(即/home/developers/domains/example.com/simplesamlphp/modules/example/lib/Auth/Process/examples/)中。

但是,尽我所能,我似乎无法让示例出现在生成的文档中。

我似乎得到的是,在生成页面的右侧:

没有超链接,或显示文件内容,或任何东西。只是“描述”,没有别的。

我曾尝试使用<code>但多行具有多个级别呈现破碎的 html 也是无用的:

这:

呈现以下 HTML:

多个嵌套<code><pre>标签呈现可怕的东西。但这是一个不同的问题。

0 投票
1 回答
109 浏览

php - PHP 中取消引用闭包的文档

我应该如何使用 doxygen 或 phpdocumentor 标记来记录 final_nums 常量?关闭在较旧的 phpdocumentor 中无法记录,但从 phpdocumentor2 开始,它们应该具有完整的 php 5.3 支持。为了使文档更复杂一点,通过取消引用,闭包是短暂的。

我相信生成的文档应该解释该常量由匿名函数的结果组成,该函数接受(int)前缀和(字符串)输入的争论并返回(int)结果。

0 投票
1 回答
143 浏览

php - 如何从 phpdocumentor 动态更改 @version 字段

我使用 phpdocumentor 标签来记录我的 php 代码类和函数,如下所示

我的问题是,有没有办法动态更改 @version 和 @link 值。好像版本改变了,我不想去每个类和函数去更新@version 和@link 字段。如果我的系统版本从 v2.0 更改为 3.0,我将不得不更改所有类和函数的文档

这样做很乏味:-)。

有什么建议么?