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

Question

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

Answer 1

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

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

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

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

Answer 2

Да, в Zend есть мастер для этого. Проверьте это brief guide.

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

1. Выберите Run-> Внешний Tools-> Внешние конфигурации Инструменты ...
2. В левой панели, выберите Program, то новый значок (крайний слева значок над панелью).
3. В правой панели выберите вкладку «Главная».
4. Введите значение generate_doc в поле Name:.
5. Введите путь к инструменту phpdoc cli в поле Location:.
6. Введите необходимые аргументы в поле «Аргументы», например. для текущего ввода проекта $ {project_loc}.
7. Для запуска внешней конфигурации выберите «Выполнить».

Чтобы снова запустить конфигурацию у вас есть несколько вариантов:

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

Answer 3

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