Разбор Javascript файлов с phpDocumentor

Недавно я играл с phpDocumentor и нашел его вполне подходящим для моих нужд. Я в основном работаю с кодовыми базами PHP/HTML/JS/CSS и хотел бы, чтобы phpDocumentor разбирал мой Javascript (и, возможно, CSS), чтобы сохранить все это вместе.Разбор Javascript файлов с phpDocumentor

Мне удалось получить phpdoc для разбора файлов javascript, содержащихся на всей кодовой базе, однако он отклоняет док-блок на уровне страницы, что приводит к его отклонению от различных тегов (см. Ниже). Я обнаружил, что добавив в открытый тег PHP (с комментарием JavaScript перед ним) в начало файла JavaScript, я могу заставить его проанализировать его так же, как файл PHP.

// <?php 
/** 
* phpdoc goes here 
* @package 
* @todo 
* - Todo 1 
* - Todo 2 
*/ 
function javascript(goes, here) { 
}

Я могу придумать возникшую проблему, если веб-сервер будет настроен на сервер .js-файлы через PHP. Есть ли другие проблемы, о которых можно подумать? Есть ли лучший способ сделать это?

Благодаря

источник

2009-11-22 ncatnow

Что касается потенциальных проблем, тот, приходит в голову то, что, поскольку вы «обманываете» phpDocumentor для разбора docblock и кода JS, вы неявно рассчитываете на токенизатор PHP (который как phpDocumentor внутренне анализирует PHP-код), чтобы успешно прочитать ваш JS-код и рассматривать его как PHP-код. Когда это удастся, я думаю, что у вас будут хорошие результаты ... ваш простой пример функции, вероятно, будет успешным. Однако, если ваш код JS будет не, выполните синтаксический анализ как PHP-код, тогда я ставлю, что phpDocumentor не будет воспринимать его как документный элемент кода, и поэтому он не будет отображаться в ваших документах.

источник

2009-11-22 13:23:58 ashnazg

Я думаю, что это немного наивно предположение думать, что нет подобного инструмента для JavaScript.

Существует инструмент под названием JSDoc, который в основном такой же, как phpdoc, но для JavaScript.

Update Пятница, 1 май 2015: -

Похоже, что новая ссылка проекта: -

https://github.com/jsdoc3/jsdoc

источник

2009-11-22 10:51:34

Я тоже не знал JSDoc. Я вижу точку @ ncatnow, хотя: Создание документации в одном месте и в макете вместо использования двух решений с двумя настройками на двух разных языках было бы lovley. По крайней мере, для исключительно функционального Javascript это должно быть возможно, не так ли? - –

Возможно, попробуйте Doxygen? Он похож на PHPDoc, поддерживает PHP и JavaScript JavaScript. Не использовал его сам, хотя. –

@Jani Hartikainen: Я думаю, что немного наивно предположить, что я еще не исследовал это. Я посмотрел на JSDoc, но это было немного сверху, когда все, что я хочу, это включить несколько JS-файлов в текущий набор документов с помощью простого «phpdoc», который позволит мне установить некоторые элементы todo, упаковать их, и так далее. Пекка прямо на деньги. Как я уже сказал, у меня уже есть эта работа с точки зрения создания документа.Мне интересно узнать, сделал ли кто-то еще это раньше, и сделал работу более чем на меня. – ncatnow

Я ищу то же самое. Я нашел JSDoc и PhpDocumentor, но учитывая тот факт, что приложение 1 (ONE) как «Целый» содержит как PHP, так и JavaScript, создавая базу приложения, я предпочел бы 1 подход к документированию проектов. Это действительно отстой, чтобы иметь 2 набора документации, 1 для php и 1 для JavaScript. То, что ole @see или inline @link не работает в случае, @see эта другая функция/класс в этом другом langauge, через какую-то другую программу документации .... получите мой дрейф?

источник

2011-11-08 01:38:47

Разбор Javascript файлов с phpDocumentor

ответ

Смежные вопросы