В настоящее время я работаю над проектом Symphony с шаблонами Twig. Чтобы узнать, что в каждом шаблоне я добавляю подробные комментарии к файлам с описаниями, параметрами, возвратами и т. Д.Можно ли использовать phpDocumentator на шаблонах Twig?
Я прыгал, чтобы иметь возможность запускать phpDocumentator (или любой другой подходящий инструмент) на этих файлы и иметь легко доступную документацию для всех наших разработчиков, однако каждый раз, когда я запустить следующую команду:
php phpDocumentor.phar -d src/dir1/dir2/CoreBundle/Resources/views/ -t docs/api/ -v
я получаю хороший Exception как результат:
[Exception]
No parsable files were found, did you specify any using the -f or -d parameter?
Я знаю, что DocBlock должно выглядеть /** comment */
но комментарии на Twig выглядят как {# comment #}
.
Есть ли способ/инструмент для создания этой документации? Если да, то как мне это сделать?
Благодаря
Я почти уверен, что нет. Docblocks нуждаются в элементах кода PHP, чтобы связать себя, поэтому даже размещение надлежащих docblocks в этих файлах twig вряд ли даст вам какой-либо вывод. В лучшем случае док-блок с файловым уровнем может преуспеть, но все. – ashnazg