Документирование программ

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

Список документируемых объектов включает в себя:

• типы данных;

• объектные интерфейсы;

• объекты (vip-интерфейсы);

• методы /свойства /объектные индексы;

• параметры методов;

• визуальные элементы (окна);

• базовые формы;

• присоединенные формы;

• потоки данных;

• меню;

• статус-строки;

• кнопки главного меню (деск);

• точки расширения;

• таблицы БД /индексы таблиц /реляционные связи.

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

Директива #doc позволяет добавить к описанию документируемого объекта произвольный текст в формате HTML. Дополнительно к стандартным тэгам HTML можно использовать тэги brief (краткое описание) и link (перекрестная ссылка).

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

Пример сгенерированной документации можно посмотреть в демо-примере к документу "Средство разработки Атлантис. Руководство по разработке атлантис-приложений".