Генератор документации PHP и Javascript

Question

Я создаю документы API для собственного веб-приложения, которое претерпевает некоторое расширение. Это проект DHTML, в котором сочетаются как некоторые OO, так и в основном процедурные PHP, и чисто процедурный Javascript. На данный момент это почти все документировано для соответствующих генераторов doc (phpdocumentor и jsdoc), но они никогда не были «связаны». Я мог бы пройти и добавить инструкции ручного ссылки к блокам doc, но управление всеми этими ссылками (например, «../jsdoc/filename.html#function») является настоящей болью.

Любые предложения для генераторов документации, которые обрабатывают оба PHP и JavaScript, и разрешить что-то вроде @see functionName между языками?

Если худшее приходит к худшему, я могу взломать скрипт, чтобы переписать URL-адреса LINK из какого-то магического синтаксиса (например, js: и php :), D действительно, а что-то, что позволит единой древовидному все.

Спасибо, Джейсона

Answer 1

Просмотрев несколько вариантов, я написал скрипт PHP, который анализирует файлы JS, вытаскивает блоки блоков и определения функций, а затем записывает их в файл, который phpdoc может обрабатывать. Ему просто нужна одна строка, добавленная в phpDocumentor.ini, поэтому она будет анализировать файлы .js.

В блоге пост говорить об этом по адресу: http://blog.jasonantman.com/2010/08/documentation-generation-for-web-apps-php-and-javascript/ И сценарий по адресу: http://svn.jasonantman.com/misc-scripts/