Докуметнация - это просто. PHP Doc Writer

Alek$ пн, 25/08/2008 - 18:25

Любой программист рано или поздно сталкивается с необходимостью документирования своего кода, особенно если он пишет opensource проект или работает в команде.

К сожалению (или к счастью?) сия проблема не минула и меня. В процессе написания документации к проекту Web Update я довольно быстро устал копаться в коде, выискивая каждую функцию и описывая ее.

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

Результатом стал скрипт PHP Doc Writer.
Этот скрипт работает со скриптами php и способен генерировать документацию в формате, совместимом с phpDocumentator.
На сегодняшний день он может работать только с документированием классов и функций, но в будущем я планирую расширить возможности, а так же добавить возможность работы с несколькими файлами одновременно.

Регистрации для работы с Doc Writer'ом не требуется, единственное, что необходимо - это включенные cookies. Так как вся информация о документации хранится в данных сессии, поэтому потеряв сессию, вы теряете все сделанные правки, если не успели их скачать, конечно.

Постовой:
История и современность рока в личном блоге Евгения Штольца Рок радио, рок музыка, рок
А так же рекомендую почитать seo блог



Trackback URL for this post:

http://nevkontakte.org.ru/trackback/257


Отправить комментарий

  • Адреса страниц и электронной почты автоматически преобразуются в ссылки.
  • Доступны HTML теги: <a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd> <img> <b> <s> <u> <p> <h3> <br> <strike> <sup> <pre> <h4> <hr>
  • Строки и параграфы переносятся автоматически.
  • You may use [inline:xx] tags to display uploaded files or images inline.
  • Текстовые смайлы будут заменены на графические.
CAPTCHA
Вы точно не бот?
18 + 1 =
Without JavaScript you won't pass captcha test, sorry. Solve this simple math problem and enter the result. E.g. for 1+3, enter 4.