Документирование модели

Задание описаний для элементов модели

Для того, чтобы сделать вашу модель более понятной, вы можете добавлять описания тех элементов модели, смысл которых может быть неясен будущим пользователям этой модели (или библиотеки). Старайтесь добавлять краткие, понятные и независимые друг от друга описания.

 Чтобы задать описание элемента
  1. Выберите элемент модели.
  2. Введите текст в секции Описание панели Свойства.

Создание документа, содержащего документацию по модели

AnyLogic предоставляет пользователям возможность создания документов с подробным структурированным описанием всех элементов модели: агентов, диаграмм состояний, потоковых диаграмм, событий, анимации и т.д. Документация содержит перечисление всех свойств элементов, а также описания элементов, заданные в секции свойств Описание (см. выше). Вы можете сохранять документацию в файлах всех наиболее распространенных форматов: PDF, DOCX и HTML. Полученные файлы могут публиковаться в интернете, распечатываться, передаваться другим пользователям и т.д. 

 Чтобы создать файл с документацией по модели

  1. Выделите любой элемент модели в графическом редакторе или в панели Проекты и выберите Инструменты > Создать документацию... из главного меню.
  2. Появится диалоговое окно Создание документации по модели.

  1. Задайте имя файла документации в поле Имя документа.

  2. Задайте местоположение файла. Перейдите к существующему каталогу с помощью диалога, открываемого по нажатию на кнопку Выбрать..., или создайте новый каталог, введя путь к нему в поле Местоположение.

  3. Выберите Формат документа (PDF, DOCX или HTML), Ориентацию листа и Размер бумаги.
  4. Щелкните мышью по кнопке Готово.
Вы увидите созданный файл документации, открытый заданным по умолчанию для данного типа файлов приложением: