Подтвердить что ты не робот

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

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

Я, вероятно, не настроил это правильно, и мне бы хотелось пошаговое учебное пособие (т.е. НЕ ЭТО ОДИН), чтобы проверьте, где я пошла не так, и, надеюсь, он что-то разобрал.

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

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

Ян

EDIT: Спасибо, что прыгнул, ашназг! Это были следующие шаги:

  • Pear не работал на моем Mac, поэтому загрузил версию 1.4.3 и распаковал ее в каталог
  • Указывает абсолютный путь к образцу файла 2 на моем HD файле под вкладкой файла
  • Указана папка вывода, доступная для всего мира.
  • Щелкнуть Создать... что-то происходит в журнале, папке со СМИ создан, но нет отчета. Log завершает "ERROR: ничего не разбирается"

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

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

4b9b3361

Ответ 1

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

Ответ 2

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

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

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

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

Ответ 3

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

Ответ 7

Вы можете посетить следующие ссылки, чтобы узнать лучшие учебники по PHP-документам Надеюсь, это поможет вам.

Пакет учебных пособий

Краткое руководство

Углубленный взгляд на использование phpDocumentor для документирования исходного кода PHP и внутренних компонентов phpDocumentor