在PHP/Codeigniter中,为什么要将@param类型全部大写?

nafvub8i  于 12个月前  发布在  PHP
关注(0)|答案(1)|浏览(109)

我使用php版本7.4.3,Codeigniter版本3.1.13和VSCode作为IDE。
当我写函数时,我会添加一些注解并定义参数,并返回如下输出。x1c 0d1x
我注意到,当我将参数和输出类型大写时,我的IDE会用漂亮的绿色突出显示它们,就好像这就是我应该沿着做的事情一样。



我是否应该将@param和@return数据格式大写,这样做的原因是什么?

whhtz7ly

whhtz7ly1#

你应该避免在PHP doc块中使用大写的STRING,因为这意味着string是一个类,但它是一个内置的标量类型。
VSCode在 *doc块 * 中为内置类型和**类类型(类或接口或枚举或trait)**显示不同的颜色。
如果使用大写字符串,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()
{
}

字符串

相关问题