Вы можете написать что угодно в комментариях. Тем не менее, это не обычное использование — @param а также @return должен описывать фактические параметры и возвращаемые значения рассматриваемой функции. Смотрите, например проект рекомендации PHP-FIG за то, что (в основном) условно.
Если вы возвращаете строку JSON, было бы лучше документировать ее как
@return string Text here describing what is being returned
У меня есть два вопроса на самом деле:
Для некоторых функций я публикую в них формы, могу ли я упомянуть их как
@params
в комментариях или что:Из какой-то функции я возвращаю данные как JSON, как упомянуть JSON как тип и формат возвращаемого значения:
Решение
Вы можете написать что угодно в комментариях. Тем не менее, это не обычное использование —
@param
а также@return
должен описывать фактические параметры и возвращаемые значения рассматриваемой функции. Смотрите, например проект рекомендации PHP-FIG за то, что (в основном) условно.Если вы возвращаете строку JSON, было бы лучше документировать ее как
@return string Text here describing what is being returned
поскольку для PHP это просто еще одна строка.
Другие решения
Других решений пока нет …