Узнай больше об проекте документатор

Материал из DOM

Это проект написан на php и представляет собой инструмент для разработчика баз данных, подобный всем вам знакомым javadoc, asdoc, phpdoc (утилитам получающим на вход код программы на некотором языке X с коментариями и формирующий соответственно документацию об исходниках в виде html, pdf или чем то еще, т.е. совмещается разработка кода с документированием (коментарии это все же хорошо) и создание отчетной (по крайней мере ее части) документации).

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

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

Наверное к тому что было написано выше добавить просто не чего, поэтому я просто приведу скриншоты использования утилиты с комментариями:

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

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

Очень важно выбрать правильную кодировку соединения для этого используйте падающий список с перечнем кодировок

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

[jump]таблица:[/jump]

[jump]таблица:поле[/jump]

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

Результаты работы утилиты документатора показаны на следующих картинках:

Последний вопрос, который надо рассмотреть - это настройки документатора - вот пример папки с его исходными кодами:

А вот пример конфигурационного файла:

Пример исходных текстов документора доступен вам для просмотра с помощью sourceshighlighter:

на спец. страницу с исходниками документатора