два или более типов данных в PHPDoc @param


Хорошо, у меня есть этот phpdoc выше моего метода класса

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

Теперь моя проблема в том, как я могу определить тип данных $lang, который может принимать только строковые и логические значения.

В других документах я видел mixed, но это неправильно отражено в моей среде разработки Eclipse с PDT.

Мой вопрос заключается в том, каков стандартный способ о том, как я могу показать, что определенный @param может принимать два или более типов данных.

ПРИМЕЧАНИЕ: phpdoc, который я привел, - это существующая документация приложения, над которым я сейчас работаю. Ну, я назначен для того, чтобы все хорошо документировать.

Author: Mp de la Vega, 2012-07-26

1 answers

Ты все сделал правильно. Ссылка PHPDoc предоставляет эти два варианта параметров, которые могут быть несколькими типами данных (выделено мной).

Тип данных должен быть допустимым типом PHP (int, string, bool и т. Д.), Именем класса для типа объекта или просто "смешанный" . Кроме того, вы можете перечислить несколько типов данных для одного параметра, разделив их канал (например, "@param int|строка $p1").

 21
Author: Ian Hunter, 2012-07-26 05:50:38