6.3
Документирование классов
После того, как класс создан, информацию о нем необходимо
документировать. Заметим, что документация предназначена для описания
предназначения класса, а не его структуры.
Пример
. Если в нашей модели присутствует класс Сотрудник, то
хорошим описанием для него будет:
Сотрудник – это человек, работающий на фирме. Класс содержит
информацию, необходимую для исполнения организацией своих обязанностей
по отношению к сотруднику (начисление зарплаты, перевод на другую
должность, увольнение и т.п.)
Плохим описанием будет описание структуры класса, которая может
быть и так описана с помощью атрибутов. Например, плохое описание класса
Сотрудник:
Имя, телефон, адрес, должность, зарплата.
В StarUML документирование классов выполняется также как и
описанное выше документирование прецедентов. Нужно выделить класс,
который вы хотите описать, открыть окно документирования Documentation
на инспекторе модели и ввести описание класса.
|
