1. дома
  2. Вопрос и ответ
  3. Любые руководства по использованию phpDocumentor?

Любые руководства по использованию phpDocumentor?

2009-12-02 5 views
21

Я хочу начать использовать phpDocumentor, но я нахожу это трудным - веб-интерфейс не играет хорошо, и я не могу его разобрать, чтобы проанализировать примеры файловЛюбые руководства по использованию phpDocumentor?

Я, вероятно, не настроил его правильно и Я хотел бы получить хороший пошаговый учебник (т. Е. NOT THIS ONE), чтобы проверить, где я поступил неправильно, и, надеюсь, его разобрал.

Но я ничего не могу найти через google - может кто-нибудь предложить какие-либо хорошие уроки или ресурсы для начала работы с phpdoc?

Большое спасибо!

Ian

EDIT: Спасибо за прыжки в, ashnazg! Это были шаги, которые я затем:

  1. груша не работает на моем Mac, так загруженной версии 1.4.3 и распаковали его в каталог
  2. Указанной абсолютный путь к образцу файла 2 на моем HD вкладке файла
  3. Указать папку с выводами, которая была доступна для всего мира
  4. Нажмите «Создать ...», что происходит в журнале, папке со СМИ создан, но нет отчета. Log завершает «ОШИБКА: ничего не анализируется»

С тех пор как Pear работал и устанавливал phpdoc таким образом; может использовать его через командную строку, но любые идеи о том, что может быть связано с веб-интерфейсом, чтобы предотвратить его разбор файла? Кажется, счастлив во всех других отношениях.

EDIT 2: Спасибо за ссылку Developer.com article, Liz: Это очень простой, но полезный быстрый запуск.

источник

2009-12-02 Polsonby

+0

Вторичный. Я пишу phpDoc-код более года, но никогда не получал чертову работу. Был бы также очень благодарен за хороший пошаговый учебник. Веб-интерфейс и документация оставляют LOT желаемым. –

+0

ОШИБКА: ничего не было разобрано ===> вам нужно указать путь сканирования -d ./ C: \ xampp \ htdocs \ my_project> phpdoc -o HTML: frames: earthli, PDF: default: default -t ./docs -d ./ – websky

ответ

-1

Google является вашим другом :)

вот один: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html

источник

2009-12-02 16:40:40

+2

Это действительно необычайно бесполезно - если вы прочитаете вопрос, который я задал, это тот самый, с которым я связан. Дело в том, что инструкции там не работают для меня, и я попросил ДРУГИЕ учебники. – Polsonby

+0

Вы правы, я дал вам неправильный ответ. Помогает ли это? http://www.developer.com/lang/php/article.php/10941_3440261_2/Documenting-PHP-Code-with-PHPDocumentor.htm –

+0

Спасибо за это; да, я обнаружил, что с помощью Google тоже :) Но это довольно хорошо. – Polsonby

0

Я не в курсе каких-либо таких руководств, касающихся использования веб-интерфейса. На самом деле я не получаю много вопросов для поддержки. Если вы можете выделить, как вы используете его без успеха, я могу помочь.

источник

2009-12-03 11:42:37 ashnazg

+0

Спасибо за это - добавлено некоторое объяснение моему сообщению выше – Polsonby

+0

«ОШИБКА: ничего не разобрано» указывает, что phpDocumentor не считает, что вы дали ему какие-либо файлы PHP для обработки. Присмотритесь к выходу во время выполнения и посмотрите, заметите ли вы, где он пытается использовать абсолютный путь, который вы ему дали. Моей первой догадкой может быть, что она содержит папку с пробелом в ее имени ... что _might_ вызывает проблему. – ashnazg

1

Лично я использую стандартные теги JavaDoc и небольшую программу Python для преобразования моего PHP в файлы Java (с пустым телом метода). Затем я запускаю JavaDoc - мне нравятся функции и взгляды на них намного лучше, чем что-либо еще, что я видел. Ну, я начал с Java до PHP.

Эта небольшая программа питон является частью моего PHP вещи и могут быть найдены на

http://code.google.com/p/mcrwebapp/source/browse/trunk/tools/php2java

(для чего это стоит.)

источник

2009-12-07 05:29:25 Don

+0

Очень интересный Дон, JavaDoc всегда был моим любимым. Не то, чтобы это было огромной задачей, но не могли бы вы поделиться своей программой Python, чтобы преобразовать PHP в скелет Java? – defines

5

документация не сказать вам это, но вы должны переместить образец файлы в каталог, который не имеет строки «учебник» в любом месте пути. phpDocumentor рассматривает «учебник» как зарезервированное слово и отказывается разбирать любые файлы, имеющие его в пути.

источник

2010-11-02 19:28:49 phenry

Смежные вопросы

 Смежные вопросы