Справочник / Общие возможности / Заметки и комментарии

Заметки и комментарии

Заметка — жёлтый листок с текстом, привязанный к элементу или связи. Она объясняет то, что не видно из самой схемы: ограничения, допущения, ссылки на требования. Комментарии в коде, наоборот, на схему не попадают.

Заметка у элемента

Слова left, right, top, bottom задают сторону. Короткая заметка пишется в одну строку после двоеточия, длинная — блоком до end note.

@startuml
class Заказ
class Оплата
Заказ --> Оплата
note right of Заказ : создаётся при оформлении
note bottom of Оплата
  Проводится через
  платёжный шлюз
end note
@enduml

Заметка на связи

Строка note on link сразу после стрелки прикрепляет заметку к этой связи.

@startuml
class Клиент
class Счёт
Клиент "1" --> "*" Счёт
note on link : у клиента может не быть счетов
@enduml

Плавающая заметка

Заметка с псевдонимом ни к чему не привязана; её можно соединить с элементами пунктиром.

@startuml
note "Все суммы — в рублях" as N1
class Заказ
class Платёж
Заказ .. N1
N1 .. Платёж
@enduml

Заметки в диаграмме последовательности

Здесь заметка ставится слева или справа от участника либо поверх нескольких участников (over).

@startuml
actor Клиент
participant Сервер
Клиент -> Сервер : запрос
note right of Сервер : проверка токена
note over Клиент, Сервер : соединение по HTTPS
@enduml

Заметки в диаграмме последовательности — пример

Комментарии в коде

Строка, начинающаяся с апострофа, — однострочный комментарий. Блок между /' и '/ — многострочный. На схему комментарии не попадают.

@startuml
' это комментарий
/' многострочный
   комментарий '/
class Товар
@enduml