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

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

Информация, необходимая для регистрации студента и оплаты обучения. Студент- это человек, обучающийся в университете.

А вот пример неправильного описания:

Имя, адрес и телефон студента.

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

Трудности при выборе имени и описании класса могут свидетельствовать о том, что это недостаточно хорошая абстракция. В следующем списке перечислены возможные варианты:

o Можно определить имя и дать краткое, четкое описание- хороший класс-кандидат;

o Можно определить имя и выбрать описание, похожее на описание другого класса,-объединить классы;

o Можно определить имя, но потребуется целая книга, чтобы описать назначение класса, - разделить класс;

o Нельзя определить имя и дать описание - требуется дополнительный анализ для выделения правильных абстракций.

Чтобы описать классы в программе Rational Rose:

1. Выберете класс в списке браузера.

2. Установите курсор в окне описания и введите описание класса.

Описание класса представлено на рис.6.

 

 

 

 

                Рис.6. Описание классов.

 

Пакеты

 

Если в системе существует много классов, управлять ими достаточно легко. Многие системы состоят из большого количества классов, поэтому необходимы пакеты.

Пакет(package) в логическом представлении модели- это набор классов и других связанных пакетов. Путем объединения классов в пакеты мы можем получить представление модели на более высоком уровне. Изучая содержимое пакета, мы, наоборот, получаем более детальное представление.

Каждый пакет содержит интерфейс, реализуемый набором его общедоступных классов (public classes), то есть тех, с которыми могут общаться классы из других пакетов. Остальные классы пакета- это классы реализации (implementation classes), которые не взаимодействуют с классами в других пакетах.

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

 созданы на этапе проработки. В более простой системе классы,

 выделенные на этапе анализа, могут быть сгруппированы в

один пакет, представляющий саму систему.

В ходе дальнейшего анализа и проектирования пакеты нужны для группировки классов, используемых в системной

архитектуре.

В языке UML  пакеты изображаются в виде папок (см. рис. 7).

 

 


                                                                   

 

                             Рис. 7. Нотация UML для пакетов.

 

      Чтобы создать пакеты в программе Rational Rose:

1. Щелкните правой кнопкой мыши по разделу Logical→View (Логическое представление) в окне браузера.

2. В появившемся контекстно-зависимом меню выберете команду New→Pack age(Создать  Пакет).

3. Введите нужное имя пакета.

 

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

Последовательность перемещения классов в пакет в программе Rational Rose:

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

2. Удерживая кнопку мыши нажатой, перетащите класс в пакет.

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

Перемещенные классы показаны на рис.9.

 

        Рис.8. Пакет, созданный в списке                  Рис.9. Перемещенные классы

                    браузера

 



Понравилась статья? Добавь ее в закладку (CTRL+D) и не забудь поделиться с друзьями:  



double arrow
Сейчас читают про: