问题标签 [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 回答
168 浏览

php - phpDocumentor:带有@var标签的DocBlock重复描述

我在 php 抽象类中有这个 DocBlock:

我用 phpDocumentor 解析了这个类;这是html结果:

正如您所看到的,两者都$foo具有$bar相同的描述($foo 之一),并且降价也没有被解析。另一方面,@todo标记的降价被正确解析。

我哪里错了?我错过了什么?

我在标签中发现了一张关于降价@var的错误票:这可能与这个问题有关吗?

0 投票
2 回答
701 浏览

symfony - 如何在 symfony 中记录控制器?

我正在尝试记录我的项目。我想记录我的控制器。在我采取行动之前,我有:

这里的返回值会显示:

在此处输入图像描述

为什么?

谢谢

编辑:

标准控制器:

0 投票
2 回答
741 浏览

php - Phpdocumentor 在供应商目录中查找自定义模板

我需要为 PhpDocumentor 创建自定义模板。问题是 中定义的路径template.xml,即使指定为绝对路径,也无法正确解析。PhpDocumentor 在供应商目录中查找它们。

尽管树枝模板位于 xml 引用的路径中,但我收到文件不存在的错误。

编辑:

我还尝试设置所有配置详细信息,phpdoc.xml希望路径将被视为相对于配置文件,但没有运气。

0 投票
0 回答
38 浏览

php - 在 phpdocumentor 中对类进行分组

我被要求使用PHPDocumentor在工作中生成开发人员的代码。我很确定我将@package 标签放在正确的位置,但是当我运行命令生成文档时,索引 html 文档仅在页面上的类段下显示最后生成的类文件,即使我在多个上运行了命令文件。请帮忙。

编辑:我已经解决了这个问题,显然文件必须一起解析才能组合在一个 html 文档中。现在我有一个新问题,是否可以将文档输出为 PDF 格式?

0 投票
5 回答
14119 浏览

php - PHPDocumentor 2 和 PHP 7 在 Doctrine 中存在 opcache 问题

希望这里有人对此有所了解。

简短的问题

我在命令行上使用 phpdoc 遇到错误,通过 pear 在 PHP 7.0.2 上安装。错误是:

如何修复此错误?

细节

Opcache 已启用并且opcache.load_comments=1位于我的 opcache.ini 文件中,分别使用以下命令进行验证:php -i | grep "Opcode"php -i | grep "opcache"。在该 .ini 文件中,我可以通过通过该文件检查启用和禁用 opcache 来验证更改是否已加载。

话虽如此,如果我opcache.load_comments=1的 .ini 文件中有,为什么我仍然会收到此错误?

谢谢!

0 投票
0 回答
105 浏览

pear - phpDocumentor 安装错误 mac OS X El Capitan

我正在尝试使用 pear 安装 phpDocumentor,当我运行时

我收到以下错误

错误:无法 mkdir /var/www/phpDocumentor/ansible/roles/phpdocumentor.environment/handlers

0 投票
0 回答
423 浏览

php - netbeans 8 phpdoc 不工作

我已将我的 phpdoc 设置如下

在此处输入图像描述

当我尝试生成 php documentor 时,它显示以下错误

错误:遇到未知的命令行选项“--ansi”,请使用 phpdoc -h 寻求帮助

我在这里做错了什么。我还在“常规”选项卡中将 php 路径设置为C:\xampp\php\php.exe

视窗 7 和 XAMPP,PHP 5.6

0 投票
0 回答
53 浏览

php - 我可以阻止 phpDocumentor 向文档添加时间戳,从而保持我的存储库干净吗?

我刚刚开始在内部项目中使用phpDocumentor 。

我想知道是否有办法阻止 phpdoc 在文档中包含时间戳。

使用时间戳,每次更新文档时,git diff 都会充满以下行:

拥有超过 30 多个文档文件,这使得文档更新的差异很难阅读。

有没有办法 - 例如。一个phpdoc.xml配置选项——我可以关闭这些时间戳吗?

配置文档中对日期和时间戳的唯一引用与我没有使用的日志文件有关。

或者,从 git 提交中排除这一点的创造性方法——如果可能的话——也是受欢迎的。

0 投票
0 回答
27 浏览

php - PHPDoc - 引用相同的评论

我想知道是否可以从方法的参数引用同一类的属性以共享相同的注释。我要解释一下:

我有这个属性:

而这个方法,其参数引用了前一个属性。

我不想写两次相同的评论,有没有什么方法可以让参数评论属性的评论?,像这样:

谢谢,问候。

0 投票
0 回答
39 浏览

php - 将代码示例添加到 PHP doc 标签的正确方法是什么?

phpDocumentor ( https://phpdoc.org ) 没有指定什么是格式内联代码示例的正确方式。我以前看过:

氧气:

围棋风格:

Java风格:

Python风格:

我知道 phpDocumentor 有@example@source但这些只是指向其他文件中行号的指针。内联代码片段更容易编写和理解。