PHP 描述一个变量

示例

的@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仅适用于一项,则可以省略。