Home > php, программирование > Интеграция phpDocumentor в Eclipse

Интеграция phpDocumentor в Eclipse

September 11th, 2008 Leave a comment Go to comments

Вот сижу, пишу код, иногда пишу комментарии. Идилия. Но вот, написавши n-ий класс, столкнулся с проблемой документации его. Ведь не только я же буду им пользоваться, а писать самому, когда есть описания методов – это не путь юного падавана. Тут на помощь приходит phpDocumentor. Но его надо бы врикрутить в среду разработки, тоесть в Eclipse, чем и займёмся.

Уже всем известно, что я использую Linux, точнее openSUSE. Это очень многое упрощает.

Сначала надо добавить репозитарий с phpDoc. Это просто:

zypper ar http://download.opensuse.org/repositories/server:/php:/applications/openSUSE_11.0/server:php:applications.repo

Теперь устанавливаем phpDocumentor:

zypper in php5-pear-phpdocumentor

Всё уже есть, осталось натравить на него Eclipse. Для этого добавляем скрипт с помощью меню Run -> External Tools ->Open External Tools Dialog. Вот так окно диалога выглядит:

  • Добавления скрипта

Добавим новый скрипт, методом нажатия New. В поле Name вписываем названия скрипта, например  phpDocumentor. В поле Location вставляем полний путь к phpDoc, у меня /usr/bin/phpdoc. В Working Directory – путь к установленому phpDoc – /usr/share/php5/PEAR/PhpDocumentor/. Самое интересное находится в поле аргументов. В нём записываются параметры phpDoc для генерации документации. Я прописал такие:

-f "${resource_loc}" -t "${project_loc}/phpDoc" -o HTML:Smarty:HandS

Это означает, что следует создать докуменацию с активного файла проекта с помощью шалонов HTML:Smarty:HandS ( более широко о шаблонах и их типах, написано в документации ) и результат положить в папку phpDoc внутри проэкта.

Вот что получилось:

  • Вот и весь скрипт

Если всё правильно сделали, то в меню появится пункт для запуска phpDoc и папочка с документацией. Более нужной функцией будет формирование документации по всему проекту. Для этого я создал ещё один, но с другими параметрами:

-d " ${project_loc}" -t "${project_loc}/phpDoc" -o HTML:Smarty:HandS -i *.svn/* -i *phpDoc/*

И как-бы нет ничего сложного.

  1. No comments yet.
  1. No trackbacks yet.