Проектная документация
Исполняемая программа и исходные тексты
© Д.И. Суясов, А.А. Шалыто
Санкт-Петербургский государственный университет информационных технологий, механики и оптики
Проектная документация
Исполняемая программа и исходные тексты
Одним из наиболее важных этапов разработки проекта на любом языке программирования является создание проектной документации. Работа над документацией, как и над самим проектом, может включать в себя несколько этапов: постановка технического задания, проектирование, написание кода и тестирование. Часть процесса создания документации можно выполнить без непосредственного участия разработчика. Помощь в этом может оказать система автоматического документирования программных проектов – система inetDoc, разработанная авторами.
Автоматическая генерация документации происходит на основе аннотаций (комментариев). Они вставляются программистом в определенные места исходного кода в момент написания проекта. Система документирования с помощью правил воспринимает комментарии и исходный текст и выделяет из них необходимую информацию. На основе заранее созданных шаблонов создается структура файлов документации.
Достоинством данного подхода является независимость от языка программирования, на котором реализуется документируемый проект. Таким образом, работа над проектом может вестись как, например, на языке программирования Java, так и на C++, на языке сценариев JavaScript или на метаязыке HTML.
В процессе создания системы автоматического документирования были созданы три варианта документатора: с использованием гибких правил на основе структурных конечных автоматов, с использованием регулярных выражений на основе классических автоматов (по Ахо) и с использованием только структурных автоматов. Все три системы решают задачу по автоматическому документированию программных проектов.