Как создать документацию phpDoc для конкретной папки в среде IDE Netbeans? - PullRequest
Новая
       31

Как создать документацию phpDoc для конкретной папки в среде IDE Netbeans?

3 голосов
/ 22 апреля 2011

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

Кто-нибудь знает, как я могу сгенерировать документацию для конкретной папки проекта через интерфейс 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 Ответ

2 голосов
/ 25 апреля 2011

Параметр -d / - directory [1] должен использоваться для выделения каталога самого высокого уровня, с которого phpDocumentor должен начать чтение. Если ваша папка Zend находится на уровне или выше уровня каталога приложения, то просто использование --directory /path/to/application должно помочь вам документировать только код приложения.

Если ваша папка Zend находится где-то внутри вашего приложения (например, в папке вашего приложения ./lib), то вы можете использовать опцию -i / - ignore [2], чтобы сообщить phpDocumentor о любых каталогах, которые он увидит, но должен игнорировать, --ignore *zend*. Просто помните, что форматирование значения игнорирования может быть сложным, поэтому посмотрите примеры в руководстве. Также имейте в виду, что при запуске phpDocumentor вы увидите эти игнорируемые папки и файлы, перечисленные в выходных данных ... phpDocumentor «игнорирует» их, не создавая документы для этих файлов. Однако он все равно должен их анализировать, если на эти объекты есть ссылки в файлах, которые документированы.

[1] - http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.directory

[2] - http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.ignore

...