Wie kann ich Typhinweise für Arrays von Objekten in PHPDoc angeben?

Typhinweise für Arrays von Objekten in PHPDoc angeben

Um ein PHPDoc-Tag für ein Array von Objekten zu deklarieren, verwenden Sie die folgende Syntax:

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

Zum Beispiel:

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

Diese Syntax informiert die IDE, dass die Variable $someObjInstances ein Array von SomeObj-Objekten ist. Die IDE stellt dann entsprechende Code-Einblicke und Typprüfungen bereit, wenn mit dieser Variablen gearbeitet wird.

IDE-Unterstützung

Beachten Sie, dass nicht alle IDEs diese Syntax für Arrays von Objekten unterstützen. PHPEd erkennt es beispielsweise möglicherweise nicht. Beliebte IDEs wie PhpStorm und Visual Studio Code unterstützen es jedoch sofort.

Alternative Syntax

In PHP 8.1 wurde eine alternative Syntax zur Angabe des Typs eingeführt von Elementen innerhalb eines Arrays:

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

Für Beispiel:

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

Mit dieser Syntax können Sie die Typen bestimmter Schlüssel innerhalb des Arrays angeben. Dies ist besonders nützlich beim Umgang mit assoziativen Arrays.

Das obige ist der detaillierte Inhalt vonWie kann ich Typhinweise für Arrays von Objekten in PHPDoc angeben?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!