Оформление документации на объектно-ориентированные программные продукты

В связи с отсутствием отечественных ГОСТов, регламентирующих правила оформления схем программного проекта с использованием объектно-ориентированного программирования, рекомендуется использовать наиболее подходящий в такой ситуации стандарт унифицированного языка моделирования – Unified Modeling Language (UML), ныне поддерживаемый многими системами программирования, например, Rational Rose.

Rational Rose - это объектно-ориентированное средство проектирования, то есть реализация CASE-технологии. Понятие CASE-технология расшифровывается как Computer-Aided Software/System Engineering - разработка систем (или программного обеспечения) с помощью компьютера.

CASE-технология - это совокупность методологий анализа, проектирования, разработки и сопровождения сложных систем программного обеспечения, поддерживаемая комплексом взаимоувязанных средств автоматизации. Она служит для проектирования программы или системы, абстрагируясь от ее реализации в коде. CASE-технология позволяет разделить создание программы или системы на этапы: проектирование, кодирование, тестирование, внедрение.

UML - модель Rose поддерживает четыре уровня представления проектируемого программного продукта:

- варианты использования (Use Case View);

- логическое представление (Logical View);

- представление компонентов (Component View);

- представление размещения (Deployment View).

Представление вариантов использования.

На этом уровне выполняется описание проекта с точки зрения его использования. Кто и куда вводит данные, что после этого делает программа и кому передает результат.

Рекомендуется выполнить следующие диаграммы:

- диаграмму прецедентов (use case diagram);

- диаграмму активности (activity diagrams).

Поведение проектируемой системы описывается с помощью модели прецедентов, которая содержит системные прецеденты, системное окружение – действующих лиц и связи между ними. Модель прецедентов должна представлять собой единое средство для обсуждения функциональности и поведения системы с заказчиком и конечным пользователем.

Основные моменты, на которые следует обратить внимание при работе над диаграммой прецедентов. Действующее лицо не входит в функциональность системы, а только воздействует на нее. Прецедент – это функция, выполняемая системой, которая приводит к значимому результату для определенного действующего лица. Пример выполнения диаграммы прецедентов для системы регистрации курсов в университете представлен в приложении З.

Основные символы диаграммы прецедентов изображены на рисунке 25.

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

Для обозначения начального и конечного состояний в потоке управления системы используются специальные символы. Начальное состояние изображается в виде закрашенного круга, а конечное – в виде закрашенного круга, обведенного дополнительной окружностью. Обычно на диаграмме существует одно начальное состояние и несколько конечных состояний – для каждого альтернативного направления.

Пример нотации языка UML для диаграммы активности приведен на рисунке 26.

Линии синхронизации (synchronization bar) предназначены для отображения действий, выполняемых параллельно.

Секции (swimlanes) делят диаграммы действий на несколько участков. Это нужно для того, чтобы показать, кто отвечает за выполнение действий на каждом участке.

Пример выполнения диаграммы активности для системы регистрации курсов в университете представлен в приложении И.