Это окно предназначено для документирования элементов модели Rose. Например, вы можете сделать короткое описание каждого действующего лица (см. рис. 2.31).
При документировании класса все, что вы напишите в окне документации, появится затем как комментарий в сгенерированном коде, что избавляет от необходимости впоследствии вносить комментарии вручную. Документация будет выводиться также в отчетах, создаваемых в среде Rose.
Если в браузере или на диаграмме выбирается другой элемент, окно документации автоматически обновляется, показывая то, что соответствует этому элементу.
Как и браузер, окно документации можно закрепить или позволить ему перемещаться свободно. По умолчанию оно появляется в нижнем левом углу окна Rose, но может быть передвинуто или скрыто.
Для перемещения окна документации:
- Щелкнув мышью, выделите границу этого окна.
- Перетащите окно на выбранное вами место экрана. Для закрепления окна документации:
- Щелкните правой кнопкой мыши на границе окна документации.
- Во всплывающем меню выберите пункт Allow Docking (Разрешить прикрепление). Рядом с этим пунктом появится отметка о том, что он выделен. Теперь окно документации можно передвигать, но только в пределах окна Rose.
Если нужно сделать окно документации свободно перемещаемым:
|
|
- Щелкните правой кнопкой мыши на границе окна документации.
- Отмените пункт Allow Docking. Теперь во всплывающем меню рядом с этим пунктом не должно быть никаких отметок. Окно документации не будет зависеть от окна Rose, и его можно будет перетаскивать в любое место внутри или вне этого окна.
рис. Окно документации
Сделать окно документации видимым или невидимым можно следующим образом:
- Щелкните правой кнопкой мыши на границе окна документации.
- В появившемся меню выделите пункт Hide (Скрыть). Теперь Rose сделает это окно видимым или невидимым в зависимости от вашего выбора.
ИЛИ
Укажите пункт меню View >- Documentation (Вид >- Документация). Окно документации будет показано или скрыто.
ИЛИ
Нажмите либо отпустите кнопку View Documentation (Показать окно документации) панели инструментов. Теперь Rose сделает это окно видимым или невидимым в зависимости от вашего выбора.