На этом шаге рассмотрим моделирование комментариев в UML.
Общее назначение примечаний – запись комментариев, оценок или пояснений в свободной форме. Размещая эти комментарии непосредственно в модели, вы превращаете ее в "склад" разнообразных артефактов, создаваемых во время разработки. Вы даже можете использовать примечания для визуализации требований и демонстрации того, как они явно связаны с частями вашей модели.
При моделировании комментариев учитывайте следующее:
- Вводите комментарий в виде текста в примечание и размещайте его рядом с элементом, к которому он относится. Вы можете показать более явную связь примечания с элементом, установив между ними зависимость.
- Помните, что вы можете скрыть или показать элементы вашей модели там, где это понадобится. Вы не обязаны делать ваши комментарии видимыми, если видимы элементы, к которым они присоединены. Используйте комментарии на диаграммах только тогда, когда это важно для передачи существенной информации.
- Если комментарий слишком длинный или включает в себя нечто большее, чем простой текст, рассмотрите возможность его размещения во внешнем документе и встраивания последнего в примечание, присоединенное к вашей модели (либо связывания этого документа с примечанием).
- По мере развития вашей модели сохраняйте комментарии, отражающие только существенные решения, которые невозможно извлечь из самой модели. Остальные же удаляйте, если только они не представляют исторического интереса.
Например, рис. 1 демонстрирует модель, которая находится в процессе разработки иерархии классов, показывая некоторые требования, формирующие модель, а также некоторые примечания к ней, высказанные при оценке дизайна.
Рис.1. Моделирование комментариев в UML
В этом примере большинство комментариев представлены в виде простого текста (такого, как замечание Мэри), но один из них (примечание в нижней части диаграммы) представляет собой гиперссылку на другой документ.
На следующем шаге рассмотрим моделирование новых свойств в UML.
