Компилятор программной документации VipDoc

В состав средства разработки Атлантис входит компилятор программной документации. Он выбирает описания основных объектов программы и генерирует для них документацию в формате html и chm.

Дополнительно к информации, содержащейся непосредственно в операторах программы (типы данных, параметры методов и т.п.), в генерируемый документ можно включить произвольный текст в формате HTML. Текст, включаемый в документацию, задается директивой компилятора #doc. Кроме стандартных тэгов HTML можно использовать тэги brief (краткое описание) и link (перекрестная ссылка).

Описание директивы #doc приведено в документе "Средство разработки Атлантис. Описание языка VIP".

Основной документируемой единицей является файл ресурса. Рекомендуется собирать приложение так, чтобы файл ресурса соответствовал компоненту приложения. Для того, чтобы можно было включить в документацию описание словаря, его надо компилировать с директивой Lot.TableDefCacheFile:

[Lot]
  TableDefCacheFile=DictCache.res

Полученный файл ресурса можно передать на обработку компилятору программной документации.

Компилятор программной документации генерирует html-страницы с описанием объектов программы и файлы проекта для компиляции сгенерированного описания в файл формата chm.

Кроме компилятора vipdoc.exe в состав Атлантис входят командные файлы res2chm.bat и chmBind.bat:

• командный файл res2chm.bat вызывает vipdoc.exe для получения документации на ресурсный файл в формате html, после чего компилирует полученные html-файлы в формат chm;

• командный файл chmBind.bat создаёт сводный документ в формате chm, объединяющий все документы в формате chm из папки %TPU%.

Описание компилятора программной документации приведено в документе "Средство разработки Атлантис. Инструменты и утилиты".

Пример сгенерированной документации можно посмотреть выполнив задание _ReadDoc.bat демо-примера или в папке VipDoc.