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

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

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

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

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

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

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

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



Trackback URL for this post:

/trackback/257
Человек вс, 20/06/2020 - 17:28

Вот ты ебун сука, лох тупой, PHPDocumentator есть давно. Дрянь ты такая, Блог гавно твой. Соси урод. Ты чё думаешь ты программист, лучше иди на грузчике пахать, даун

S.Zhirov ср, 15/09/2020 - 19:31

Ну-ну полегче :)

Ещё один человек сб, 25/09/2020 - 15:36

Я согласен!!!

haM3r чт, 24/06/2020 - 01:15

Как всё-таки прекрасно, что у меня есть javadoc

Alek$ чт, 24/06/2020 - 12:19

Дык это тот же JavaDoc, только адаптированный под PHP =)



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

CAPTCHA
Вы точно не бот?
15 + 2 =
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.