问题标签 [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 投票
2 回答
3158 浏览

php - 用 composer 安装 phpdocumentor/reflection

我想在我的 SF2 项目中安装包 phpdocumentor/reflexion。所以我运行以下命令composer require "phpdocumentor/reflection",但出现以下堆栈错误:

这是我的composer.json

}

我不确切知道问题出在哪里,但我认为作曲家尝试安装 phpdocumentor/reflection (3.0.1) 的最后一个稳定版本。这个包依赖于 phpdocumentor/reflection-docblock (~2.0) 但它应该是 3.1.1。

任何想法如何解决这个问题?

0 投票
1 回答
8207 浏览

php - PhpDocs:可以在参数描述中链接方法吗?

是否可以链接到另一个方法/类/属性/等。在我的项目内内联@deprecated标签内?像这样:

?

0 投票
1 回答
85 浏览

php - 从 CLI 调用时带有 PHPDocumentor 的无限循环(但通过 SSH 很好)

直到昨天,我在我们的生产服务器(CentOS 6.8)上使用了 PHPDocumentor 版本 2.8.5。一切正常。我不得不升级到 2.9.0 版。因为 PHPDoc 无法生成 PHP7 的文档。

当我通过 SSH 运行以下脚本时,一切正常:

在此处输入图像描述

但是,当我尝试使用 PHP 运行脚本时

编码陷入无限循环,没有生成任何文档。我希望页面在 3 分钟后失败,但它只是不断循环......

即使尝试执行 PHPDocumentor,它也会陷入无限循环:

有没有人遇到过类似的问题?

0 投票
1 回答
418 浏览

phpdoc - phpdocumentor @example 行数

我想知道如何使用这个。我正在尝试使用这个: https ://www.phpdoc.org/docs/latest/references/phpdoc/tags/example.html

我这样使用它:

起始行确实有效,但行数无效,它显示为描述的一部分。

在文档中它说像这样使用它:

当我尝试使用括号时,它根本不起作用,所以我不知道如何限制显示的行数。

(附带问题:是否可以在示例中启用突出显示,或显示行号?)

0 投票
1 回答
692 浏览

symfony - 带有 PHP 7.1 返回类型声明的 phpDocumentor

我们正在尝试将 phpDocumentor 用于运行 PHP 7.1 的 Symfony 3 站点。

我们在几乎每个实体上都使用返回类型声明来保持整洁。phpDocumentor 似乎不支持这一点,尽管我在他们的 GitHub 上看到了几个对 PHP 7 支持的引用。

这是每个实体的错误:解析错误:语法错误,意外':',期待';' 或者 '{'

0 投票
1 回答
199 浏览

php - 为自定义功能扩展 phpdocumentor2

我开始将 phpdocumentor2 用于 php 项目,并希望对其进行扩展,使其具有自定义功能。

我想让它在默认生成的内容下输出“最新的函数/方法/类”。我的想法是当它运行时能够比较解析文件中的任何元素是否有新的@version 可能甚至是文件更改日期。

有谁知道这是否可能以及如何使用此文档生成器或其他工具来做到这一点?

也有人知道当前的 phpdocumentator2 是否正确支持@uses,如果不是,还有什么其他解决方法可以使它工作?我需要它来连接我的项目类。

0 投票
2 回答
83 浏览

php - 如果我用冒号关闭标签(示例),它会对 PHPdoc 产生影响吗?

我总是在我的 phpdoc 块中使用冒号。例如,而不是:

而不是上面的,我使用以下样式:

你看,我更喜欢用冒号分隔标签和描述。它更易于阅读并且具有更多风格。但我想知道这对 PHPdoc 解析 docbloc 有什么影响吗?

0 投票
1 回答
642 浏览

symfony - 将 phpdocumentor 与 Symfony3 一起使用

我想将phpDocumentor与 Symfony3 一起使用。因为它们彼此不兼容,如here所述,我已经安装了 phpDocumentor 使用 pear 作为推荐。

我的buidl.xml 是这样称呼它的。

当我跑步时$ phing

我收到以下错误。

dompdf/我的目录中没有文件夹,vendor/因为它不是使用安装的composer

还有什么我可以使用的吗?有没有办法停止 phpdoc 寻找 composer.json 文件并使用vendor项目目录?

0 投票
1 回答
714 浏览

php - phpDocumentor 文件夹 - 未找到此文件的摘要

我的项目中有一堆我试图忽略的文件夹。不幸的是,phpDocumentor 似乎试图访问某些文件夹并出现“权限被拒绝”错误。

我试图通过排除这些目录phpdoc.dist.xml

忽略列表的工作方式是排除文件夹内的项目是豁免的,但是文件夹本身不是。因此,phpDocumentor 尝试将文件夹作为文件读取,从而导致错误。这些在最终的 HTML 中也可见。

截图 html

如何正确忽略文件夹?我知道我可以尝试使用--ignore sqlbuddy/,docs/,但是我很确定它与ignore在配置中使用 XML 标记相同。此外,我宁愿将忽略列表放在一个中央文件中,也不愿有两个单独的位置——一个在命令中,一个在配置 XML 中。


再次阅读我的问题后,我发现问题可能与此有关:

还有一个有趣的配置文档,我已经阅读了很多次,但它似乎并没有解决我的具体问题。

0 投票
2 回答
334 浏览

php - 为不同的访问级别生成 PHP 文档

我正在一个需要生成 3 个或更多文档的 php 项目中工作,这些文档比其他文档更具限制性。对于文档,我使用 PhpDocumentor 2。我发现的唯一方法是 2 级文档,使用@internaltag 和 --parseprivate 选项(用于生成私有文档)。

是否可以生成具有中间限制级别的第三个文档?

我也尝试过@access使用--visibility 标记,但它在phpDocumentor 的第2 版中不起作用。或@ignore标记,但我没有找到一种方法来生成带有此标记设置的代码的第三个文档。