描述变量
@var
关键字可用于描述以下类型和用法:
- 一个类属性
- 本地或全局变量
- 类或全局常量
class Example {
/** @var string This is something that stays the same */
const UNCHANGING = "Untouchable";
/** @var string $some_str This is some string */
public $some_str;
/**
* @var array $stuff This is a collection of stuff
* @var array $nonsense These are nonsense
*/
private $stuff, $nonsense;
...
}
类型可以是内置 PHP 类型之一,也可以是用户定义的类,包括名称空间。
应包含变量的名称,但如果 docblock 仅适用于一个项目,则可以省略。