Модераторы: skyboy, MoLeX, Aliance, ksnk
  

Поиск:

Ответ в темуСоздание новой темы Создание опроса
> PhpDocumentor 
:(
    Опции темы
Gold Dragon
Дата 18.12.2014, 15:29 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Призрачный
****


Профиль
Группа: Экс. модератор
Сообщений: 6753
Регистрация: 1.3.2004
Где: Россия, Тамбов

Репутация: 10
Всего: 71



Собственно вопрос: как использовать PhpDocumentor?

Мне необходимо создать что-то типа справочника по своему проекту.. 


--------------------
Нельзя жить в прошлом, оно уже прошло.
Нельзя жить в будущем, оно ещё не наступило.
Нужно жить в настоящем, помня прошлое и думая о будущем!
PM MAIL WWW ICQ   Вверх
_zorn_
Дата 19.12.2014, 05:44 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Эксперт
***


Профиль
Группа: Завсегдатай
Сообщений: 1076
Регистрация: 21.8.2007

Репутация: 6
Всего: 12



А что не понятно в официальной документации ?
http://www.phpdoc.org/docs/latest/getting-...umentation.html
PM MAIL   Вверх
Gold Dragon
Дата 19.12.2014, 08:31 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Призрачный
****


Профиль
Группа: Экс. модератор
Сообщений: 6753
Регистрация: 1.3.2004
Где: Россия, Тамбов

Репутация: 10
Всего: 71



Цитата(_zorn_ @  19.12.2014,  06:44 Найти цитируемый пост)
А что не понятно в официальной документации ?
ну если спросил, то наверное не понял. В документации слишком всё кратко и на инглиш 

ps
на выходе хочу получить html-код с навигацией по своему проекту.. если такое возможно конечно..


Это сообщение отредактировал(а) Gold Dragon - 19.12.2014, 08:32


--------------------
Нельзя жить в прошлом, оно уже прошло.
Нельзя жить в будущем, оно ещё не наступило.
Нужно жить в настоящем, помня прошлое и думая о будущем!
PM MAIL WWW ICQ   Вверх
_zorn_
Дата 19.12.2014, 10:16 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Эксперт
***


Профиль
Группа: Завсегдатай
Сообщений: 1076
Регистрация: 21.8.2007

Репутация: 6
Всего: 12



Насколько я понял - это что вроде javadoc https://ru.wikipedia.org/wiki/Javadoc

Просто комментируете функции/классы/методы/файлы/и т.п. определенным образом и запускаете phpdoc
По моему все предельно ясно.
PM MAIL   Вверх
Gold Dragon
Дата 19.12.2014, 13:18 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Призрачный
****


Профиль
Группа: Экс. модератор
Сообщений: 6753
Регистрация: 1.3.2004
Где: Россия, Тамбов

Репутация: 10
Всего: 71



Сейчас попробую.. может это именно оно...

Всё прокомментировано, вот и хочу посмотреть что получается

Добавлено @ 13:19
Цитата

Javadoc — генератор документации в HTML-формате из комментариев исходного кода на Java
:(

Это сообщение отредактировал(а) Gold Dragon - 19.12.2014, 13:20


--------------------
Нельзя жить в прошлом, оно уже прошло.
Нельзя жить в будущем, оно ещё не наступило.
Нужно жить в настоящем, помня прошлое и думая о будущем!
PM MAIL WWW ICQ   Вверх
Gold Dragon
Дата 19.12.2014, 15:58 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Призрачный
****


Профиль
Группа: Экс. модератор
Сообщений: 6753
Регистрация: 1.3.2004
Где: Россия, Тамбов

Репутация: 10
Всего: 71



Кое как что-то поставил, но это какой-то ужас... ошибка на ошибке. Под PHP5.3+ вообще не адаптирован
правлю пути и ошибки, но что-то их уж совсем много.. видимо легче самому написать smile


--------------------
Нельзя жить в прошлом, оно уже прошло.
Нельзя жить в будущем, оно ещё не наступило.
Нужно жить в настоящем, помня прошлое и думая о будущем!
PM MAIL WWW ICQ   Вверх
Vardoulacha
Дата 19.12.2014, 16:12 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Бывалый
*


Профиль
Группа: Участник
Сообщений: 184
Регистрация: 11.8.2005

Репутация: 7
Всего: 8



Сам недавно перевел один проект на phpDoc комментарии и хотел составить документацию, перерыл множество библиотек, и... ничего, нет ни одного нормального ((

Все делают документацию только из классов, а если проект состоит из функций, а также кучки левых файлов не php, то все, тушите свет сливайте воду, адекватной навигации не составить (( а хочется то всего ничего
1) составить структуру всего проекта, просто тупо ссылки на файлы
2) входишь в файл, если он класс тогда понятно, свойства методы, а если обычный php то просто все что закомментировано показать (функции, переменные, константы)
3) список всех переменных, всех констант

вот пожалуй и все, этого уже достаточно чтобы можно было показать любому программисту и рассказать кратко откуда ноги растут, НО где же ты такой инструмент
PM MAIL   Вверх
Aliance
Дата 19.12.2014, 17:02 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


I ♥ <script>
****


Профиль
Группа: Модератор
Сообщений: 6418
Регистрация: 2.8.2004
Где: spb

Репутация: 14
Всего: 137



Цитата(Gold Dragon @  19.12.2014,  16:58 Найти цитируемый пост)
видимо легче самому написать

конечно проще самому

ReflectionClass::getDocComment()
ReflectionProperty::getDocComment 
ReflectionFunctionAbstract::getDocComment 
PM MAIL WWW ICQ Skype   Вверх
_zorn_
Дата 19.12.2014, 19:12 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Эксперт
***


Профиль
Группа: Завсегдатай
Сообщений: 1076
Регистрация: 21.8.2007

Репутация: 6
Всего: 12



Цитата(Gold Dragon @  19.12.2014,  20:18 Найти цитируемый пост)
:(

Я ссылку к тому дал, что по моему мнению - вдохновение бралось из javadoc
А поймешь как работает первоисточник, поймешь и производные.
PM MAIL   Вверх
Gold Dragon
Дата 20.12.2014, 14:20 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Призрачный
****


Профиль
Группа: Экс. модератор
Сообщений: 6753
Регистрация: 1.3.2004
Где: Россия, Тамбов

Репутация: 10
Всего: 71



Aliance, спасибо за ссылки.. даже и не знал ну или не обращал внимание smile

В общем нашёл Doxygen. Поставил клиента под Винду. Запустил настройки по умолчанию и.... всё офигенно получилось!!! Есть маленькие нюансы, но думаю это уже нужно делать тонкую настройку..

Добавлено через 1 минуту и 5 секунд
PS
код всегдак стараюсь комментировать полностью, по крайней мере описание функций/классов с примерами.. а вот захотел получить справку.. не тут то было  smile 


--------------------
Нельзя жить в прошлом, оно уже прошло.
Нельзя жить в будущем, оно ещё не наступило.
Нужно жить в настоящем, помня прошлое и думая о будущем!
PM MAIL WWW ICQ   Вверх
Сумасшедший
Дата 3.1.2015, 20:38 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Чилавек-Каропка
***


Профиль
Группа: Завсегдатай
Сообщений: 1503
Регистрация: 15.8.2004
Где: Москва

Репутация: нет
Всего: 107



Цитата(Gold Dragon @  19.12.2014,  15:58 Найти цитируемый пост)
Под PHP5.3+ вообще не адаптирован

А можно пример? Ато я только при работе с php5.6 столкнулся с нерабочестью документирования функций с переменным числом аргументов.


--------------------
Однажды ты спросишь, а я отвечу: "Время ожидания специалиста - 10 минут". Ты бросишь трубку, так и не узнав, что Ваш звонок очень важен для нас!
PM MAIL WWW Jabber   Вверх
Gold Dragon
Дата 7.1.2015, 09:54 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Призрачный
****


Профиль
Группа: Экс. модератор
Сообщений: 6753
Регистрация: 1.3.2004
Где: Россия, Тамбов

Репутация: 10
Всего: 71



Цитата(Сумасшедший @  3.1.2015,  21:38 Найти цитируемый пост)
А можно пример? Ато я только при работе с php5.6 столкнулся с нерабочестью документирования функций с переменным числом аргументов. 
Я только потом нашёл что существет PhpDocumentor2, а я видимо использовал первую версию.. Но и вторую не получилось поставить :( да и  Doxygen начал выдавать какие-то ошибки. В общем ещё что-то пытался ставить. Вроде как написано, но 99% это одна и таже перепечатанная статья. Видимо автор что-то пропустил в описание думая что это само собой разумеещееся, но сказать другим про это забыл.. 
В итоге я так и не решил проблему что и как ставить и пока только документирую код... Может найдётся тот кто всё пошагово покажет в картинках да ещё и с видео smile

ЗЫ
много ошибок было по типу
Код

$a = $b[name];

т.е. даже без кавычек



--------------------
Нельзя жить в прошлом, оно уже прошло.
Нельзя жить в будущем, оно ещё не наступило.
Нужно жить в настоящем, помня прошлое и думая о будущем!
PM MAIL WWW ICQ   Вверх
Сумасшедший
Дата 13.1.2015, 11:02 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Чилавек-Каропка
***


Профиль
Группа: Завсегдатай
Сообщений: 1503
Регистрация: 15.8.2004
Где: Москва

Репутация: нет
Всего: 107



Хм. Я ключи в одинарных кавычках вписываю. Пока не сталкивался с этим.

Ставил просто: 
Код

emerge dev-php/phpDocumentor


А запускаю: 
Код

phpdoc -d /home/www/aoe -t /tmp/phpdoctest



--------------------
Однажды ты спросишь, а я отвечу: "Время ожидания специалиста - 10 минут". Ты бросишь трубку, так и не узнав, что Ваш звонок очень важен для нас!
PM MAIL WWW Jabber   Вверх
Gold Dragon
Дата 13.1.2015, 19:14 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Призрачный
****


Профиль
Группа: Экс. модератор
Сообщений: 6753
Регистрация: 1.3.2004
Где: Россия, Тамбов

Репутация: 10
Всего: 71



Сумасшедший, у тебя какой-нибудь WAMP или всё сам ручками ставил? У использую OpenServer


--------------------
Нельзя жить в прошлом, оно уже прошло.
Нельзя жить в будущем, оно ещё не наступило.
Нужно жить в настоящем, помня прошлое и думая о будущем!
PM MAIL WWW ICQ   Вверх
_zorn_
Дата 14.1.2015, 03:06 (ссылка) | (нет голосов) Загрузка ... Загрузка ... Быстрая цитата Цитата


Эксперт
***


Профиль
Группа: Завсегдатай
Сообщений: 1076
Регистрация: 21.8.2007

Репутация: 6
Всего: 12



Цитата
emerge dev-php/phpDocumentor

Говорит о том что у него гента smile
PM MAIL   Вверх
  
Ответ в темуСоздание новой темы Создание опроса
Правила форума "PHP"
Aliance
IZ@TOP
skyboy
SamDark
MoLeX

Новичкам:

  • PHP редакторы собираются и обсуждаются здесь
  • Электронные книги по PHP, документацию можно найти здесь
  • Интерпретатор PHP, полную документацию можно скачать на PHP.NET

Важно:

  • Не брезгуйте пользоваться тегами [code=php]КОД[/code] для повышения читабельности текста/кода.
  • Перед созданием новой темы воспользуйтесь поиском и загляните в FAQ
  • Действия модераторов можно обсудить здесь

Внимание:

  • Темы "ищу скрипт", "подскажите скрипт" и т.п. будут переноситься в форум "Web-технологии"
  • Темы с именами: "Срочно", "помогите", "не знаю как делать" будут УДАЛЯТЬСЯ

Если Вам понравилась атмосфера форума, заходите к нам чаще! С уважением, IZ@TOP, skyboy, SamDark, MoLeX, awers.

 
0 Пользователей читают эту тему (0 Гостей и 0 Скрытых Пользователей)
0 Пользователей:
« Предыдущая тема | PHP: Общие вопросы | Следующая тема »


 




[ Время генерации скрипта: 0.0770 ]   [ Использовано запросов: 22 ]   [ GZIP включён ]


Реклама на сайте     Информационное спонсорство

 
По вопросам размещения рекламы пишите на vladimir(sobaka)vingrad.ru
Отказ от ответственности     Powered by Invision Power Board(R) 1.3 © 2003  IPS, Inc.