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

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

Для описания атрибутов в программе Rational Rose:

1. В окне браузера щелкните по значку «+» слева от имени класса, чтобы раскрыть список его свойств.

2. Выберите атрибут, щелкнув по нему мышью.

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

Описание атрибута название (name) класса предмет (Course) показано на рис. 7.5.

Рис. 7.5. Описание атрибута название