deux ou plusieurs types de données dans PHPdoc @param
ok j'ai cette phpdoc au-dessus de ma méthode de classe
/**
* this a function that translates the text
* @param string|boolean $lang if string the string given in the parameter will be the language code that will represent the language desired, if true, this will translate based on the website's current language, if false will not translate.
*/
maintenant mon problème est, est comment je peux définir le type de données du $lang qui n'accepte que la chaîne et le booléen.
dans d'autres documentations j'ai vu mixed mais il ne se reflète pas correctement dans mon IDE D'éclipse avec PDT.
Ma question est qu'est-ce que le standard comment je peut afficher qu'un certain @param est possible d'accepter deux ou plusieurs types de type de données.
NOTE: le phpdoc que j'ai donné est une documentation existante de l'application à laquelle je travaille actuellement. Eh bien, je suis affecté pour la documentation de tout bien.
1 réponses
vous avez bien fait. PHPDoc référence donne ces deux options pour les paramètres qui peuvent être des types de données multiples (emphasis mine).
le type de données doit être un type PHP valide (int, string, bool, etc), un nom de la classe pour le type d'objet, ou tout simplement "mixte". En outre, vous pouvez liste de plusieurs types de données pour un seul paramètre en délimitant avec la pipe (par exemple "@paramint|string $p1").