描述變數
@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 僅適用於一個專案,則可以省略。