Комментарии для документации PHP пост данных и возвращения JSON

У меня есть два вопроса на самом деле:

  1. Для некоторых функций я публикую в них формы, могу ли я упомянуть их как @params в комментариях или что:

    /* some descriptions
    *
    * @param string userName
    */public function add(){
    $userName = $_POST['user']
    ......
    }
    
  2. Из какой-то функции я возвращаю данные как JSON, как упомянуть JSON как тип и формат возвращаемого значения:

     /* some descriptions
    *
    * @return JSON [{id, name,...}]
    */
    

0

Решение

Вы можете написать что угодно в комментариях. Тем не менее, это не обычное использование — @param а также @return должен описывать фактические параметры и возвращаемые значения рассматриваемой функции. Смотрите, например проект рекомендации PHP-FIG за то, что (в основном) условно.

Если вы возвращаете строку JSON, было бы лучше документировать ее как

@return string Text here describing what is being returned

поскольку для PHP это просто еще одна строка.

1

Другие решения

Других решений пока нет …

По вопросам рекламы ammmcru@yandex.ru
Adblock
detector