PHP Lang
  1. PHP Lang
  3. Генератор документации PHPDoc в или из Eclipse?
Intereting Posts
Может ли имя файла PHP (или каталог полного пути) содержать символы UTF-8? отправка массивов в _GET в php Запрос на ранжирование группы MYSQL PHP Paypal: как забрать авторизованный платеж? Поддержка Emojis в уведомлении Apple push CryptoJS шифрует AES с парольной фразой, но для расшифровки PHP требуется ключ CURLOPT_FOLLOWLOCATION не может быть активировано, если safe_mode включен или открыт open_basedir Посещает счетчик без базы данных с PHP PHP, как поток потока mp3 снова Как предотвратить повторное замещение вторым регулярным выражением? Отображение темы по умолчанию при загрузке веб-сайта WordPress на сервере Исключить исключение SoapFault: SOAP-ERROR: анализ WSDL JSON Кодирование и декодирование символов UTF8 в PHP IE10 передает файлы cookie по субдоменам по умолчанию Невозможно проверить подпись PyOpenSSL в C #

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

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

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

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

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

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

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

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

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

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

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

  1. Выберите значок «Внешние инструменты» на значке внешних инструментов меню « http://img.ruphp.com/documentation/», затем нажмите «generate_doc».
  2. Выберите Run-> External Tools-> generate_doc
  3. Hit Alt + R, E, 1 (предполагается, что generate_doc является первым элементом в списке, в противном случае выберите соответствующий номер)