due o più tipi di dati in PHPDoc @param

ok io ho questo phpdoc sopra del mio metodo di classedue o più tipi di dati in PHPDoc @param

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

ora il mio problema è, è come posso definire il tipo di dati della $lang che può accettare sia corda e SOLO booleano.

In altri documenti ho visto mixed ma non si riflette correttamente nel mio IDE Eclipse con PDT.

La mia domanda è qual è il modo standard su come posso visualizzare che un certo @param è possibile accettare due o più tipi di tipi di dati.

NOTA: il phpdoc che ho fornito è una documentazione esistente dell'applicazione a cui sto lavorando ora. Beh, sono incaricato di documentare tutto bene.

fonte

2012-07-26 Mp de la Vega

Hai fatto bene. Lo PHPDoc reference fornisce queste due opzioni per i parametri che possono essere più tipi di dati (sottolineatura mia).

Il tipo di dati dovrebbe essere un tipo valido di PHP (int, string, bool, ecc), un nome classe per il tipo di oggetto, o semplicemente "mista". Inoltre, è possibile elencare più tipi di dati per un singolo parametro li delimitando con la pipe (ad esempio "@param int | string $ p1").

fonte

2012-07-26 05:50:38

ahh .. beh sono solo preoccupato perché l'eclipse PDT non lo sta visualizzando bene. ok grazie –

@ Mahan Lo sta visualizzando diversamente da '@param integer' o' @param boolean'? –

Penso che PDT abbia ancora delle evoluzioni da fare per quanto riguarda la capacità di interpretare tutto ciò che i docblock PHP si sono evoluti per contenere. Forse uno studio per costruire un riassunto di quante informazioni docblock ogni versione PDT sa come usare è in ordine. – ashnazg

due o più tipi di dati in PHPDoc @param

risposta

Problemi correlati