Как создать документацию phpDoc для определенной папки в IDE Netbeans?
В связи с тем, что нам необходимо интегрировать Zend Framework в корневой каталог нашего проекта, и что генерация этой документации будет бесполезной и займет много времени, я хотел бы генерировать документацию только для всех файлов в папке application.
Кто-нибудь знает, как я могу создать документацию для определенной папки проекта через интерфейс Netbeans 7.0?
Обновление:
Лучшее, что я нашел до сих пор, было:
Откройте окно терминала из netbeans, и тип:
sudo phpdoc -d public_html/yoursite.dev/application/ -t public_html/yoursite.dev/docs/
Обновление 2
Предположим, что наша библиотека Zend находится внутри projectrootname/library/Zend мы также можем попробовать, перейдя к: Tools > Options > Php > PhpDoc и разместив следующее:
/usr/bin/phpdoc -i library/Zend/ -o HTML:frames:earthli
По крайней мере, для меня это, кажется, не работает, потому что, когда я пытаюсь сгенерировать документацию, я получаю ошибки разрешения, отображаемые в окне вывода.
Спасибо
1 ответ:
Параметр-d/--directory [1] следует использовать для выделения наиболее высокоуровневого каталога кода, из которого вы хотите начать чтение phpDocumentor. Если ваша папка Zend находится на уровне каталога приложений или выше, то простое использование
--directory /path/to/applicationдолжно помочь вам документировать только код приложения.Если ваша папка Zend находится где-то внутри вашего приложения (например, в вашем приложении ./ lib folder), то вы можете использовать опцию-i/--ignore [2], чтобы сообщить phpDocumentor о любых каталогах, которые он будет видеть, но должен игнорировать,
--ignore *zend*. Просто имейте в виду, что форматирование значения ignore может быть сложным, поэтому смотрите примеры в руководстве. Кроме того, имейте в виду, что при запуске phpDocumentor вы будете видеть эти игнорируемые папки и файлы, перечисленные в выходных данных... phpDocumentor "игнорирует" их, не генерируя документы для этих файлов. Тем не менее, он все еще должен анализировать их, в случае, если эти объекты ссылаются в файлах, которые действительно документируются.
Comments