Книга: Rational Rose 2000 и UML Визуальное моделирование
Документирование классов
Документирование классов
После того как класс создан, информацию о нем необходимо отразить в документации. Документация предназначена для описания назначения класса, а не его структуры. Например, класс студент может быть описан следующим образом:
Информация, необходимая для регистрации студента и оплаты обучения. Студент — это человек, обучающийся в университете.
А вот пример неправильного описания:
Имя, адрес и телефон студента.
Оно раскрывает только структуру класса, которую можно увидеть, посмотрев на список атрибутов, и не поясняет, для чего нужен данный класс.
Трудности при выборе имени и описании класса могут свидетельствовать о том, что это недостаточно хорошая абстракция. В следующем списке перечислены возможнее варианты:
? можно определить имя и дать краткое, четкое описание — хороший класс-кандидат;
? можно определить имя и выбрать описание, похожее на описание другого класса, — объединить классы;
? можно определить имя, но потребуется целая книга, чтобы описать назначение класса, — разделить класс;
? нельзя определить имя и дать описание — требуется дополнительный анализ для выделения правильных абстракций.
Чтобы описать классы в программе Rational Rose:
1. Выберите класс в списке браузера.
2. Установите курсор в окне описания и введите описание класса. Описание класса представлено на рис. 4.6.
Рис. 4.6. Описание класса
Оглавление книги
- Документирование сценариев
- Глава 4. Поиск классов
- Кодирование, тестирование и документирование версии
- Документирование операций
- Документирование атрибутов
- 9.7.4. Иерархии классов и абстрактные классы
- 8.8.5. Шаг 4. Задание интерфейсов классов
- У14.4 Наследование без классов
- 3.6. Качество классов и объектов
- Соотношение классов и записей
- 4.6.3. Документирование файлов
- Лекция № 12. Связи классов сущностей