Хороший способ документировать действия контроллера в PHPDoc?
Я пытаюсь найти хороший способ документировать действия контроллера в рамках php mvc. Для меня действительно важно, чтобы там был способ вставить URL-адрес для действия, моя проблема в том, что я не могу найти способ вписать это в схему для phpdoc.
2 answers
Я действительно не понимаю вашу проблему/вопрос. Вы можете поместить все, что хотите, в блок phpdoc, включая соответствующий URL-адрес для действия контроллера (вы даже можете использовать разметку, если хотите):
/**
* This is some foo action.
*
* URL: /foo/bar/baz
*/
public function fooAction(/* ... */) {
// ...
}
Тем не менее, если вы специально хотите использовать пользовательский тег, такой как @url или что-то в этом роде, вам просто нужно использовать опцию командной строки -ct, чтобы сообщить phpdoc, что вы не хотите, чтобы он выдавал ошибки синтаксического анализа, когда он сталкивается с вашими пользовательскими тегами:
# Will specify custom tag @url
phpdoc -ct url ...
Решение зависит от программного обеспечения, которое вы используете для создания документации.
У меня была аналогичная проблема, и я переключился на доксиген. Doxygen позволяет добавлять пользовательскую информацию в ваши комментарии к документам, такие как @action_url, и может генерировать и выводить html, pdf, справочные страницы,....