Блог

Главная - Вопросы по программированию - Возможно ли написать документацию PHPDoc для @param без указания типа?

Возможно ли написать документацию PHPDoc для @param без указания типа?

#phpstorm #phpdoc

#phpstorm #phpdoc

Вопрос:

Я использую PhpStorm. Когда я помещаю следующую документацию PHPDoc для функции:

 /**
 * @param $id application identifier
 */
public function foo($id)

И я запускаю команду «Быстрая документация» (Ctrl Q) для функции в PhpStorm, она показывает это:

Параметры: Идентификатор App ModelsApplication $id

Похоже, что по какой-то причине IDE интерпретирует первое слово описания параметра application как тип для параметра. Я не хочу указывать тип параметра (я не знаю, что это такое), я просто хочу добавить краткое описание параметра в документацию. Что мне делать?

Комментарии:

1. Тогда используйте mixed тип (или какой-либо другой универсальный). Для PHPDoc требуется тип. В вашем случае IDE обрабатывает это как синтаксис, подобный PHPDoc, где тип идет после имени.

Ответ №1:

Если вы не знаете, что это такое, вы можете использовать mixed . Тип идет перед $id , а часть после $id будет использоваться в качестве описания.

 /**
 * @param mixed $id application identifier
 */
public function foo($id)