PHP中文档中使用的伪类型与变量

经常写一些类或者方法(函数)注释的时候都会有@param或者@return类型的描述,如下代码块大括号所示:

/**
 * @desc 检查是否可预订
 * 
 * @param {Array} params
 * @return {Object}
 */
function check(){
    // TO DO
}

代码块大括号的array|object其实是伪类型;
伪类型(pseudo-types) 是 PHP 文档里用于指示参数可以使用的类型和值。 请注意,它们不是 PHP 语言里原生类型。 所以不能把伪类型用于自定义函数里的类型约束(typehint)。

mixed

mixed 说明一个参数可以接受多种不同的(但不一定是所有的)类型。

例如 gettype() 可以接受所有的 PHP 类型,str_replace() 可以接受字符串和数组。

number

number 说明一个参数可以是 integer 或者 float

callback

本文档中在 PHP 5.4 引入 callable 类型之前使用 了 callback 伪类型。二者含义完全相同。

array|object

array|object 意思是参数既可以是 array 也可以是 object

void

void 作为返回类型意味着函数的返回值是无用的。void 作为参数列表意味着函数不接受任何参数。

当然除了这些类型,还有我们常用到的Boolean、Integer、Float、String

了解了这些类型,现在写注释就不会漏写了这些类型描述了吧。
转自php.net

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容