在 PHP/Codeigniter 中，@param 类型全部大写的原因是什么？

Question

我的 IDE 使用 php 版本 7.4.3、Codeigniter 版本 3.1.13 和 VSCode。

当我编写函数时，我会添加一些注释并定义参数，并像这样返回输出。

我注意到，当我将参数和输出类型大写时，我的 IDE 会以漂亮的绿色突出显示它们，就好像这就是我一直应该做的事情。

我应该将 @param 和 @return 数据类型大写吗？这样做的原因是什么？

Answer 1

您应该避免在 PHP 文档块中使用大写的

STRING

，因为这意味着 string 是一个类，但它是一个标量类型。

VSCode 在文档块中为内置类型和类类型（类或接口或枚举或特征）显示不同的颜色。

如果您使用大写的 STRING，您的 IDE 可能会出现混乱。

我强烈建议使用较低的字符串版本，如您的图片所示。当然，这取决于您和您团队的编码风格，但最流行的 PHP 标准之一 (PSR-12) 表示：

所有 PHP 保留关键字和类型 [1][2] 必须小写。

无论如何，PHP 允许使用不区分大小写的名称，但为了可读性，它应该是小写的。所有用户定义的类类型都将是“漂亮的绿色”。当然，如果你更改 VSCode 主题，颜色可能会改变。

您可以使用这些类型并在 VSCode 中检查它们。

/**
 * @return object|resource|array|string|float|double|int|bool|false|true|null|mixed|void|self|static|callable|never|iterable|\Traversable|\Closure|\stdClass|\Error|\Iterator
 */
function test()
{
}