Любой программист рано или поздно сталкивается с необходимостью документирования своего кода, особенно если он пишет opensource проект или работает в команде.
К сожалению (или к счастью?) сия проблема не минула и меня. В процессе написания документации к проекту Web Update я довольно быстро устал копаться в коде, выискивая каждую функцию и описывая ее.
Поразмыслив за кружечкой кофе я пришел к выводу, что неплохо бы написать какую-нибудь программу, которая будет сама извлекать определения функций из исходного кода и предоставлять удобный интерфейс редактирования описаний к этим функциям.
Результатом стал скрипт PHP Doc Writer.
Этот скрипт работает со скриптами php и способен генерировать документацию в формате, совместимом с phpDocumentator.
На сегодняшний день он может работать только с документированием классов и функций, но в будущем я планирую расширить возможности, а так же добавить возможность работы с несколькими файлами одновременно.