Расположение плагина, параметры генерации, результат генерации

Плагин генерации документации располагается в пункте Утилиты для каждого плагина продуктов платоформы Flexberry. Например, ORM -> Утилиты -> Генерация документации по диаграммам.

В результате будет открыто окно со списком параметров, которые можно включить в итоговый документ.

Параметры генерации документации

Свойство	Описание
Столбцы - перечень атрибутов класса
Название	Название атрибута класса
Тип	Тип атрибута для форм приложения
Тип в БД	Тип атрибута для базы данных
Хранилище	Наименование класса в базе данных
Обязательность	Обязателен или нет атрибут для сохранения класса
Хранимость	Хранимый или нет атрибут (stored/ not stored)
Описание	Комментарий к атрибуту
Скрытые атрибуты - атрибуты, существующие в таблице базы данных, но не отображаемые на диаграмме и форме
Первичный ключ	Первичный ключ таблицы
ДатаСоздания	Дата и время создания записи
ДатаИзменения	Дата и время последнего изменения
Вид - внешний вид документа
Заголовки перед каждым классом	Отображать ли заголовки перед каждым классом
В терминах баз данных	Использовать терминологию баз данных или программирования

Результат генерации документации

По кнопке Старт создается два документа:

• MS Excel - перечень классов и заданных параметров
• .TXT - список классов и свойств, имеющих в названии длинные имена

Плагин предлагает открыть файлы на просмотр вопросом во всплывающем окне. Для просмотра следует нажать Да.