PHPDoc でオブジェクトの配列の型ヒントを指定するにはどうすればよいですか?

PHPDoc でのオブジェクトの配列の型ヒントの指定

オブジェクトの配列の PHPDoc タグを宣言するには、次の構文を使用します。

@var array<\Fully\Qualified\Class\Name>

向け例:

  /** @var SomeObj[] */
  private $someObjInstances;

この構文は、$someObjInstances 変数が SomeObj オブジェクトの配列であることを IDE に通知します。 IDE は、その変数を操作するときに、適切なコード情報と型チェックを提供します。

IDE サポート

すべての IDE がオブジェクトの配列に対してこの構文をサポートしているわけではないことに注意してください。たとえば、PHPEd はそれを認識しない可能性があります。ただし、PhpStorm や Visual Studio Code などの一般的な IDE は、そのままの状態でこれをサポートしています。

代替構文

PHP 8.1 では、型を指定するための代替構文が導入されました。配列内の要素の数:

@var array{key: type, key: type, ...}

の場合例:

  /** @var array{object: SomeObj, string: string} */
  private $someObjsArray;

この構文を使用すると、配列内の特定のキーのタイプを指定できます。これは、連想配列を扱う場合に特に便利です。

以上がPHPDoc でオブジェクトの配列の型ヒントを指定するにはどうすればよいですか?の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。