Генератор документации PHPDoc в или из Eclipse?

Я развиваюсь с помощью Eclipse + PDT. Я добавляю комментарии phpdoc в свой код, но на самом деле никогда не создавал итоговую документацию в Eclipse. Как мне это сделать - есть ли какая-то функциональность в Eclipse, или генерация doc должна выполняться извне?

Ответ 1

Чтобы создать документацию, вы должны использовать phpDocumentor, который может быть установлен как пакет PEAR.

Затем вы должны вызвать его из командной строки; Я никогда не видел, чтобы это вызвало из Eclipse PDT.

Большое решение - иметь платформу с непрерывной интеграцией (например, phpUnderControl) и интегрировать ее в создание phpdoc в файле конфигурации сборки; таким образом, phpdoc генерируется каждый раз, когда кто-то совершает (или один раз в день, или когда вы хотите ^^).

В Eclipse PDT вы можете вызвать "внешние инструменты" (см. "Выполнить > Внешние инструменты" в меню); это позволит вам запустить команду phpdoc (как вы делаете из CLI); но это определенно не так удобно, как предлагает Zend Studio - не такая же цена, хотя ^^

Ответ 2

Еще один отличный инструмент для создания документации - ApiGen. Он не требует установки с PEAR (но включает его), и его можно использовать как отдельный пакет.

Ответ 3

Да, в Zend есть мастер для этого. Ознакомьтесь с этим краткое руководство.

В качестве альтернативы вы можете создать внешнюю конфигурацию запуска для вызова стандартного phpDocumentor.

Выберите "Выполнить" → "Внешние инструменты" → "Конфигурации внешних инструментов".
В левой панели выберите "Программа", затем новый значок (самый левый значок над областью).
В правой панели выберите вкладку "Главная".
Введите generate_doc в поле Name:.
Введите путь к инструменту phpdoc cli в поле Location:.
Введите любые необходимые аргументы в поле "Аргументы", например. для текущего ввода проекта ${project_loc}.
Чтобы запустить внешнюю конфигурацию, выберите "Выполнить".

Для повторного запуска конфигурации у вас есть несколько вариантов:

Выберите значок "Внешние инструменты" в строке меню значок внешних инструментов http://help.eclipse.org/ganymede/topic/org.eclipse.cdt.doc.user/images/icon%5Fext%5Ftools.png" и нажмите кнопку generate_doc
Выберите Run- > External Tools- > generate_doc
Хит Alt + R, E, 1 (предполагается, что generate_doc является первым элементом в списке, в противном случае выберите соответствующий номер)