два или более типов данных в 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 IDE с PDT.

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

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


person Netorica    schedule 26.07.2012    source источник


Ответы (1)


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

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

person Ian Hunter    schedule 26.07.2012
comment
ааа ... ну, я просто беспокоюсь, почему eclipse PDT не отображает это хорошо. Спасибо - person Netorica; 26.07.2012
comment
@Mahan Он отображает это иначе, чем @param integer или @param boolean? - person Ian Hunter; 26.07.2012
comment
Я думаю, что PDT еще предстоит доработать, чтобы иметь возможность интерпретировать все, что эволюционировало в docblocks PHP. Возможно, следует провести исследование, чтобы составить сводку о том, сколько информации о блоке документов может использовать каждая версия PDT. - person ashnazg; 26.07.2012