PlantUMLでお絵描きしているとき、あるオブジェクトに対し、コメントというかノートというか、注釈を追加することができます。
その1:1行で書く
まずは、シンプルな描き方。
note <位置> of <オブジェクト> : <内容>
って感じです。
<位置>
は、top
bottom
left
right
を指定できます。
note top of hako : 記述1行で\nノート
その2 : ブロックで書く
行数が多くなりそうな場合、note
~ end note
で括ると描き易いです。
note bottom of hako ブロックで ノート end note
その3 : フローティングなノート
as <エイリアス名>
で定義すると、オブジェクトを指定せずにフローティングなノートを描画できます。
note "記述1行で\nフローティングなノート\n<i>as floatnote1" as floatnote1
その4 : フローティングなノート(2)
note
~ end note
で括る場合も、as <エイリアス名>
でフローティングなノートを描画できます。
note as floatnote2 ノートブロックで フローティングなノート <i>as floatnote2 end note
その5 : フローティングなノートをオブジェクトにくっつける
as <エイリアス名>
を使って、他のオブジェクトと連結できます。
note as floatnote3 "as XXX" で名前付けしたノートは その名前を使って他のオブジェクトと接続できる <i>as floatnote3 end note hako -r- floatnote3
まとめ
上記の方法でノートを描画すると、次のようになります。
ソースコードの全体は以下から。
title <u>ノート <i>"note"</i> の使い方 rectangle "箱" as hako '==== その 1 ==== note top of hako : 記述1行で\nノート '==== その 2 ==== note bottom of hako ブロックで ノート end note '==== その 3 ==== note "記述1行で\nフローティングなノート\n<i>as floatnote1" as floatnote1 '==== その 4 ==== note as floatnote2 ノートブロックで フローティングなノート <i>as floatnote2 end note '==== その 5 ==== note as floatnote3 "as XXX" で名前付けしたノートは その名前を使って他のオブジェクトと接続できる <i>as floatnote3 end note hako -r- floatnote3 /'skinparam 設定'/ skinparam usecaseBorderColor #gray skinparam componentBorderColor #gray skinparam packageFontStyle plane skinparam noteBackgroundColor #white skinparam backgroundColor #fdfbf4 scale 5/5