问题标签 [docblocks]

我是 phpDocumentor 的新手，尽管我过去曾广泛使用过 JavaDoc。

首先，我创建了以下测试文件a.php：

然后我使用以下命令行运行phpDocumentor v3.0.0 ：

生成的文档存在以下问题 - 请参阅此处的屏幕截图：

1. 生成的 HTML 中既不存在文件级注释，也不存在全局变量 $var。
2. 对于常量 DO_IT，缺少默认值的第一个字母（'alse'）。

知道我做错了什么吗？谢谢！

假设我有一个类Book，它有一个名为$chapters. 在我正在使用的实现中，此属性由一个名为 的通用辅助类表示，该类Collection又包含一个Chapter类数组。

例子：

$chapters是否可以对属性进行注释，Book以便我的 IDE 知道它是一个Collection对象，但是对该集合的方法的调用将返回一个实例getItems()数组？Chapter

我可以在不创建子类Collection和注释的情况下做到这一点吗？

编辑：我认为我的目标并不明确。我正在寻找一个在类之外的Book类的类型提示，并就它的属性提供指导$items——像这样（我确定这是无效的）：

在 VS Code 中，可以自动生成 doc 块信息，如下所示：

我假设@throws文档信息暗示了可能引发的潜在异常。如果是这样，有没有办法突出显示或检测 VS Code 中的文件中可能引发未处理异常的位置？

我希望能够更轻松地在我的代码中找到被忽视的区域，这些区域可能会引发未处理的异常并重构它们。

PHP trait 不能声明一个常量，但是是否可以使用 DocComment（或其他方式）声明一个常量，如果使用该 trait 的类定义了该 trait 可能“使用”它？

例如，假设一个类Book是绑定到books表的模型。该框架要求将表定义为TABLE常量：

创建模型时，我的 IDE 会自动完成TABLE常量，因为它是在Model. 精彩的。

现在，假设我有一个称为Sluggabletrait 的 trait，它可以帮助开发人员管理书的 URL slug（例如treasure-island），其中一个配置选项是是否自动调整书名。说这是由AUTOMATIC_SLUGS常数控制的。

显然，特征不能定义AUTOMATIC_SLUGS常量，因为这是不允许的，但是 IDE 不能建议或以其他方式验证AUTOMATIC_SLUGS常量。所以我的模型Books现在有一个警告（在我的 IDE 中）告诉我AUTOMATIC_SLUGS没有使用：

有没有办法让我 - 在特性上，并且不重构以使用静态属性 - 声明Sluggable将检查一个调用的常量AUTOMATIC_SLUGS并让 IDE 建议它/不认为它没用？

是否有一个有效的 Docblock 标签可以让 trait 知道它将与哪个类/接口一起使用？例如（下面是纯编的代码）。

您可以看到来自父类的HasAvatar特征访问。getId()

但是，当您在 IDE 中时，它无法找到getId()，因为它不属于该特征，并且没有注释提示说明在哪里可以找到此方法。

因此有没有办法告诉这个特征它将以特定的方式实现？例如

这会让 IDE 知道它可以访问所有内容Authenticatable？

谢谢

我可以在FakerPHP/Faker包中看到这个 PHPDoc 块，但我不知道是什么@template意思？您可以在此行的包的主分支中找到它

我有一个返回时间戳的方法。我想做这样的事情：

但是，我认为不@return array<int, timestamp>成立。

在文档块中指定时间戳的有效格式是什么？

将 laravel 魔法与范围一起使用，我可以输入代码中使用的范围名称（hasName）。但是，如果正在使用 scopeHasName 以及在何处使用它，则 IDE 将不会拾取它。有没有办法“别名”这两个。即告诉IDE“hasName”实际上是在“scopeHasName”中实现的？