Цитата(_zorn_ @ 19.12.2014, 06:44  ) |
| А что не понятно в официальной документации ? |
ps
на выходе хочу получить html-код с навигацией по своему проекту.. если такое возможно конечно..
| Версия для печати темы
Нажмите сюда для просмотра этой темы в оригинальном формате |
| Форум программистов > PHP: Общие вопросы > PhpDocumentor |
| Автор: Gold Dragon 18.12.2014, 15:29 |
| Собственно вопрос: как использовать PhpDocumentor? Мне необходимо создать что-то типа справочника по своему проекту.. |
| Автор: _zorn_ 19.12.2014, 05:44 |
| А что не понятно в официальной документации ? http://www.phpdoc.org/docs/latest/getting-started/your-first-set-of-documentation.html |
| Автор: Gold Dragon 19.12.2014, 08:31 | ||
ps на выходе хочу получить html-код с навигацией по своему проекту.. если такое возможно конечно.. |
| Автор: _zorn_ 19.12.2014, 10:16 |
| Насколько я понял - это что вроде javadoc https://ru.wikipedia.org/wiki/Javadoc Просто комментируете функции/классы/методы/файлы/и т.п. определенным образом и запускаете phpdoc По моему все предельно ясно. |
| Автор: Gold Dragon 19.12.2014, 13:18 | ||
| Сейчас попробую.. может это именно оно... Всё прокомментировано, вот и хочу посмотреть что получается Добавлено @ 13:19
|
| Автор: Gold Dragon 19.12.2014, 15:58 |
| Кое как что-то поставил, но это какой-то ужас... ошибка на ошибке. Под PHP5.3+ вообще не адаптирован правлю пути и ошибки, но что-то их уж совсем много.. видимо легче самому написать  |
| Автор: Vardoulacha 19.12.2014, 16:12 |
| Сам недавно перевел один проект на phpDoc комментарии и хотел составить документацию, перерыл множество библиотек, и... ничего, нет ни одного нормального (( Все делают документацию только из классов, а если проект состоит из функций, а также кучки левых файлов не php, то все, тушите свет сливайте воду, адекватной навигации не составить (( а хочется то всего ничего 1) составить структуру всего проекта, просто тупо ссылки на файлы 2) входишь в файл, если он класс тогда понятно, свойства методы, а если обычный php то просто все что закомментировано показать (функции, переменные, константы) 3) список всех переменных, всех констант вот пожалуй и все, этого уже достаточно чтобы можно было показать любому программисту и рассказать кратко откуда ноги растут, НО где же ты такой инструмент |
| Автор: Aliance 19.12.2014, 17:02 | ||
конечно проще самому http://php.net/manual/en/reflectionclass.getdoccomment.php http://php.net/manual/ru/reflectionproperty.getdoccomment.php http://php.net/manual/ru/reflectionfunctionabstract.getdoccomment.php |
| Автор: _zorn_ 19.12.2014, 19:12 | ||
Я ссылку к тому дал, что по моему мнению - вдохновение бралось из javadoc А поймешь как работает первоисточник, поймешь и производные. |
| Автор: Gold Dragon 20.12.2014, 14:20 |
| Aliance, спасибо за ссылки.. даже и не знал ну или не обращал внимание В общем нашёл http://www.stack.nl/~dimitri/doxygen/download.html. Поставил клиента под Винду. Запустил настройки по умолчанию и.... всё офигенно получилось!!! Есть маленькие нюансы, но думаю это уже нужно делать тонкую настройку.. Добавлено через 1 минуту и 5 секунд PS код всегдак стараюсь комментировать полностью, по крайней мере описание функций/классов с примерами.. а вот захотел получить справку.. не тут то было  |
| Автор: Сумасшедший 3.1.2015, 20:38 | ||
А можно пример? Ато я только при работе с php5.6 столкнулся с нерабочестью документирования функций с переменным числом аргументов. |
| Автор: Gold Dragon 7.1.2015, 09:54 | ||||
В итоге я так и не решил проблему что и как ставить и пока только документирую код... Может найдётся тот кто всё пошагово покажет в картинках да ещё и с видео ЗЫ много ошибок было по типу
т.е. даже без кавычек |
| Автор: Сумасшедший 13.1.2015, 11:02 | ||||
| Хм. Я ключи в одинарных кавычках вписываю. Пока не сталкивался с этим. Ставил просто:
А запускаю:
|
| Автор: Gold Dragon 13.1.2015, 19:14 |
| Сумасшедший, у тебя какой-нибудь WAMP или всё сам ручками ставил? У использую OpenServer |
| Автор: _zorn_ 14.1.2015, 03:06 | ||
Говорит о том что у него гента |