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

Question

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

Answer 1

Для создания документации вам следует использовать phpДокументор, который можно установить как пакет PEAR.

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

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

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

Answer 2

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

Answer 3

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

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

1. Выберите «Выполнить» -> «Внешние инструменты» -> «Конфигурации внешних инструментов»...
2. На левой панели выберите «Программа», затем новый значок (крайний левый значок над панелью).
3. На правой панели выберите вкладку «Основные».
4. Введите «generate_doc» в поле «Имя»:поле.
5. Введите путь к инструменту phpdoc cli в поле «Местоположение»:поле.
6. Введите любые необходимые аргументы в поле «Аргументы», например.для текущего ввода проекта ${project_loc}.
7. Чтобы запустить внешнюю конфигурацию, выберите «Выполнить».

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

1. Выберите значок «Внешние инструменты» в строке меню. значок внешних инструментов http://help.eclipse.org/ganymede/topic/org.eclipse.cdt.doc.user/images/icon%5Fext%5Ftools.png" затем нажмите «Generate_doc»
2. Выберите «Выполнить»->Внешние инструменты->generate_doc.
3. Нажмите Alt+R, E, 1 (при условии, чтоgenerate_doc — первый элемент в списке, в противном случае выберите соответствующий номер)