问题标签 [docblocks]

如果您愿意看一下我在这一行正在从事的项目（函数 api() ）。

https://github.com/wtfzdotnet/php-tmdb-api/blob/develop/lib/Tmdb/Client.php#L79

IDE 实际自动完成返回对象实例的方法的正确方法是什么？我现在使用它的方式从所有可能的返回对象返回所有方法。

短的; 如何确保 IDE 识别正在返回的对象的自动完成方法是由 switch 语句定义的？我想知道IDE自动完成这个的正确方法是什么，以及最好的PHPDoc策略（它确实有一个接口，但是暂时是空的）。

更新 1

正如第一条评论所建议的那样，我试图调整“电影”的案例作为测试：

并添加

但这在尝试调用时无法按预期运行：

但是，当我将 getMovieApi 的范围更改为 public 并直接将其称为：

它按预期工作，但是我真的更喜欢我的初始方法，因为它看起来更干净（至少对我来说）。如果返回值是从 switch 语句派生的，真的不可能获得正确的自动完成吗？

Is there a way to ask phpStorm to update the contents of a docblock? eg if I have the following code

and add another parameter

is there a way to ask phpStorm to create the @param $anotherParameter in my docblock? (in a single keystroke or by menu selection)?

比如说我有我的名字作为作者：

如何在我的 DocBlock 中包含我的网站、我的许可证和我的版权？我应该使用哪些标签？

还有什么标签是最常见的标签，我该如何使用它们？

假设我有一个像这样的文档块：

或者 ：

如何解析 docblock 以在同一个文件中使用这些字符串？

@version我的目标是每次更改时只需使用 docblock 中的数字贯穿整个文档，而无需添加另一个$version = 'myversion'

我知道有 docblock 解析器类，但我找不到如何读取自己的文件。（我自己的问题- 从很久以前开始，提供了一些解决方案，但仅适用于外部文件，无论如何都不理想，因为它涉及每次打开和写入文件）

此外，在梨示例页面中，似乎他们以某种方式使用（据我所知）版本号作为变量 - 但我无法理解如何......

示例版本 I

示例版本 II：

（我不知道为什么这两个示例页面不同（URLen和zh）-也许它只是一个小网络错误。）但无论如何我不明白如何应用它。

重点是：我如何将 docblock 用作文件本身中的字符串 - 或者反转逻辑并使用 docblock 中的文档中的变量，因此我总是需要声明版本号（可能还有其他变量）ONCE。

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

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

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

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

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

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

我正在编写程序 PHP 风格的脚本，但仍想尽我所能记录所有内容。这就是我使用 DocBlock 注释的原因。作为新手，我想知道如何在以下场景中使用它们（专门为此问题编写的代码）：

让我们假设$i该功能需要。我应该如何记录它？我不能把它放在函数 DocBlock 中，因为它不是一个参数。

该示例在该类中有两个类似的变量，但由于我没有编写面向对象的代码，所以我不能放在$i函数之外（或者只是不想改变我的编码风格以能够使用 DocBlocks）。

另一种方法是不记录这些“内部”变量，因为对于使用该函数，它们并不重要。

我目前有这样的代码：

有没有更简洁的方法来做到这一点？

有没有更清洁的方法来做到这一点？

它不会将值转换为布尔值，而是将其转换为整数。

因此，假设在我的某些方法中的控制器中，我想返回这样的视图：

在我的文档块中，我想记录此方法返回的内容。我不知道如何记录此方法正在返回视图。那是资源吗？是混合的吗？

这是有效的吗？：

您如何记录您的方法正在返回重定向到其他页面？

假设我有以下类存根：

该beCourteous()方法实际上不接受任何输入，也不产生任何返回值。什么是正确的 phpDoc 块？