Меню
Что нового?

Документирования PHP кода

23i

Guest
Документирования PHP кода

Интересует кт очем пользуеться для создания документации к проекту: описание функций, классов, примеры использования функция,классов.
Какие программы для этого есть? Желательно чтобы такое документирование можно было вести нескольким программистам.
 
svetasmirnova

svetasmirnova

маленький монстрик
Я - phpDocumentor

Официальный сайт phpDoc + phpDocumentor:
http://phpdoc.org/

Очень удобно: пишешь обычные комментарии, а потом автоматически генерируешь мануал. Всё! И через месяц по собственному коду уже не надо лазить в поисках "что же этот аргумент означает".

Ваш пост уже третий по этой теме за последние три дня: посмотрите ещё
http://phpclub.ru/talk/showthread.php?s=&postid=410380
 

23i

Guest
сталкивался с ним - во всчком случаи месяцев 8 назад эта прелесть просто не могал переварить объем моего проекта - около 4 мегабайт библиотек - уходила в неопределнную задумчивость....
посмотрим что сейчас.
ещё есть предложения?
в частности если комментарии делаються в формате Zend Studio, если на этот счет мысли?
 
svetasmirnova

svetasmirnova

маленький монстрик
-~{}~ 13.12.04 01:48:

>в неопределнную задумчивость....
он по разным причинам входит, хотя для того, что бы создать его собственную документацию (в результате около 20Mb документации получилось), я quit-аю все программы :)

А можно поподробнее о формате ZendStudio: не слышала о нём раньше.
(Пользуюсь GNU редактором)
 

23i

Guest
комменты там следующего вида
PHP: 
/**
* @return переконверироваемая строка
* @param строка для конвертации $string
* @desc конвертирует строку из  windows-1251 в UTF кодировку
*/
собственно у меня и нет проблемы чт оя не знаю что аргумент означает или класс, просто очеьн много всего есть и порой ужде не знаешь есть ли что либо подобное или нет
вот для этого то и нужна подобная система
 
svetasmirnova

svetasmirnova

маленький монстрик
Похоже, что это phpDoc и есть (в смысле стандарт оформления)

Ещё для документации используется формат DocBookXML (официальный PHP мануал, например) www.docbook.org
Но мне кажется, что для документирования кода это не слишком удобно.

Также существует peardoc (его также поддерживает phpDocumentor) Я с ним мало знакома (пока), но это что-то наподобие DocBook
 

Sad Spirit

мизантроп (Старожил PHPClub)
Команда форума
Автор оригинала: svetasmirnova
Также существует peardoc (его также поддерживает phpDocumentor) Я с ним мало знакома (пока), но это что-то наподобие DocBook
Нажмите для раскрытия...
Это и есть DocBook, и phpDocumentor его умеет генерировать.
 

23i

Guest
понял
спасбио
считаю тему закрытой
будем документировать:)
 
svetasmirnova

svetasmirnova

маленький монстрик
>считаю тему закрытой
тем не менее...
Дополнение ко вчерашнему ночному...
>Но мне кажется, что для документирования кода это не слишком удобно.
Для составления документации в формате DocBook XML придётся создавать отдельные файлы документации. Что хорошо использовать для составления подробных мануалов, предназначенных конечному пользователю (который может быть пользователем программных библиотек). Для составления же рабочей документации это дело требует большей дисциплины и поэтому усложняет жизнь, что я вчера столь неясно высказала :)
 

23i

Guest
хм
и что предлагаеться?

-~{}~ 13.12.04 13:23:

просто когда 4 метра библиотек тут уже для самог осебя нужна подробная дока:)
 
svetasmirnova

svetasmirnova

маленький монстрик

23i

Guest
Попробовал чудесно работает с ZDE.
Все генерируеться, покапаюсь ещё в настройках -а так вешь очень удобная.
Респект авторам.
 

DiTHER

bang bang
хорошая, но не такая хорошая как хотелось бы :)

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

Но аналогов лучше, увы, нет. :).
 
Войдите или зарегистрируйтесь для ответа.
Сверху