Maison >développement back-end >tutoriel php >Comment puis-je spécifier des types d'objets de tableau dans les annotations PHPDoc ?

Comment puis-je spécifier des types d'objets de tableau dans les annotations PHPDoc ?

Linda Hamilton
Linda Hamiltonoriginal
2024-12-01 05:10:09694parcourir

How Can I Specify Array Types of Objects in PHPDoc Annotations?

Saisie de tableaux dans PHPDoc pour les collections d'objets

Dans les annotations PHPDoc, la balise @var indique le type de données des variables membres pour l'auto-complétion de l'IDE. Cependant, étendre cette fonctionnalité à des tableaux d'objets pose un défi.

Le besoin de saisie de tableaux

Considérez le code suivant, où $someObjInstance est un tableau d'objets SomeObj :

/** @var SomeObj */
private $someObjInstance;

Cette annotation est insuffisante pour la prise en charge de l'IDE lors d'une itération sur le array.

Syntaxe valide pour le typage de tableau

Pour spécifier un tableau d'objets dans PHPDoc, utilisez la syntaxe suivante :

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

Cette syntaxe informe l'EDI que $someObjInstance est un tableau contenant des instances de SomeObj class.

Recommandation de la documentation PHPDoc

La documentation officielle PHPDoc suggère d'utiliser un seul type entre crochets pour spécifier le type de chaque élément du tableau :

/** @var int[] */
private $integerArray;

Cela garantit que chaque élément du tableau est du type spécifié.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!

Déclaration:
Le contenu de cet article est volontairement contribué par les internautes et les droits d'auteur appartiennent à l'auteur original. Ce site n'assume aucune responsabilité légale correspondante. Si vous trouvez un contenu suspecté de plagiat ou de contrefaçon, veuillez contacter admin@php.cn