zwei oder mehr Datentypen in PHPDoc @param

Question

ok Ich habe tun, um diese phpdoc über meine Klassenmethode

/** 
* 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. 
*/ 

jetzt mein Problem ist, ist, wie ich den Datentyp der $lang definieren kann, die sowohl Zeichenfolge akzeptieren und NUR boolesch.

In anderen Dokumentationen sah ich mixed, aber es spiegelt sich nicht richtig in meiner Eclipse-IDE mit PDT.

Meine Frage ist, was ist die Standard Weg auf, wie ich anzeigen kann, dass eine bestimmte @param ist möglich, zwei oder mehr Arten von Datentyp zu akzeptieren.

HINWEIS: der phpdoc, den ich angegeben habe, ist eine vorhandene Dokumentation der Anwendung, an der ich gerade arbeite. Nun, ich bin beauftragt, alles gut zu dokumentieren.

Answer 1

Sie haben es richtig gemacht. Die PHPDoc reference gibt diese beiden Optionen für Parameter, die mehrere Datentypen sein können (Hervorhebung meins).

Der Datentyp muss ein gültiger PHP-Typ (int, string, bool, usw.), ein Klassenname für die Art von Objekt oder einfach "gemischt" sein. Weiter können Sie mehrere Datentypen für einen einzelnen Parameter auflisten, indem Sie sie mit der Pipe (z. B. "@param int | string $ p1") begrenzen.