You can vote to improve syntax about packages/namespaces !
ユースケース図
いくつかの例を示します。
ユースケース
ユースケースは丸括弧で囲んで使います(丸括弧の対は 楕円に似ているからです)。usecase キーワードを使ってユースケースを定義することもできます。 as キーワードを使ってエイリアスを定義することもできます。このエイリアスは あとで、ユースケースの関係を定義するために使います。
@startuml
(First usecase)
(Another usecase) as (UC2)
usecase UC3
usecase (Last\nusecase) as UC4
@enduml
アクター
アクターは2つのコロンで囲まれます。
actor キーワードを使ってアクターを定義することもできます。 as キーワードを使ってエイリアスを定義することもできます。このエイリアスはあとで、ユースケースの関係を定義するために使います。
後から説明しますが、アクターの定義は必須ではありません。
@startuml
:First Actor:
:Another\nactor: as Men2
actor Men3
actor :Last actor: as Men4
@enduml
ユースケースの説明
クオート記号を使うことにより、複数行にわたる説明を記述できます。
また、次の区切り記号を使用できます： --..==__。 区切り記号の中にはタイトルを記入できます。
@startuml
usecase UC1 as "You can use
several lines to define your usecase.
You can also use separators.
--
Several separators are possible.
==
And you can add titles:
..Conclusion..
This allows large description."
@enduml
簡単な例
アクターとユースケースを繋げるには --> 矢印を使います。
矢印に使うハイフン - の数を増やすと矢印を長くできます。 矢印の定義に : を使うことにより矢印にラベルをつけることができます。
以下の例では User は定義なしにアクターとして使われています。
@startuml
User -> (Start)
User --> (Use the application) : A small label
:Main Admin: ---> (Use the application) : This is\nyet another\nlabel
@enduml
= 継承 =
もしアクターやユースケースが継承をする場合には、 <|-- 記号を使います。
@startuml
:Main Admin: as Admin
(Use the application) as (Use)
User <|-- Admin
(Start) <|-- (Use)
@enduml
ノートの使用方法
オブジェクトに関連のあるノートを作成するには note left of 、 note right of 、 note top of 、 note bottom of キーワードを使います。
または note キーワードを使ってノートを作成し、 .. 記号を使ってオブジェクトに紐づけることができます。
@startuml
:Main Admin: as Admin
(Use the application) as (Use)
User -> (Start)
User --> (Use)
Admin ---> (Use)
note right of Admin : This is an example.
note right of (Use)
A note can also
be on several lines
end note
note "This note is connected\nto several objects." as N2
(Start) .. N2
N2 .. (Use)
@enduml
ステレオタイプ
<< と >> を使い、アクターとユースケースを定義中にステレオタイプを追加できます。
@startuml
User << Human >>
:Main Database: as MySql << Application >>
(Start) << One Shot >>
(Use the application) as (Use) << Main >>
User -> (Start)
User --> (Use)
MySql --> (Use)
@enduml
矢印の方向を変えるには
デフォルトでは、クラス間の線は2個のハイフン -- で表され、縦方向につながります。横方向の線を描くには以下のようにハイフン1つかドット1つを書きます。
@startuml
:user: --> (Use case 1)
:user: -> (Use case 2)
@enduml
線を反対にすることでも方向を変えることができます。
@startuml
(Use case 1) <.. :user:
(Use case 2) <- :user:
@enduml
矢印の内側に left、 right、 up、 down を書くことによっても線の方向を変えられます。
@startuml
:user: -left-> (dummyLeft)
:user: -right-> (dummyRight)
:user: -up-> (dummyUp)
:user: -down-> (dummyDown)
@enduml
例えば、 -down- ではなく -d- など、各方向の頭文字、または頭2文字（ -do- ）だけ使って矢印を短くすることも出来ます。
ただし、この機能の使いすぎには注意しましょう。ほとんどの場合、特別なことをしなくても Graphviz がその場にあった表示を選びます。
図を分割する
newpage キーワードは、いくつかのページや画像に図を分割します。
@startuml
:actor1: --> (Usecase1)
newpage
:actor2: --> (Usecase2)
@enduml
左から右に描画する
デフォルトの作図方向は top to bottom となっています。
@startuml
'default
top to bottom direction
user1 --> (Usecase 1)
user2 --> (Usecase 2)
@enduml
left to right direction コマンドを使います。
@startuml
left to right direction
user1 --> (Usecase 1)
user2 --> (Usecase 2)
@enduml
スキン設定（Skinparam）
ダイアグラムの色やフォントを変更するには skinparam コマンドを使用します。
このコマンドは以下の場面で使用できます。
- ダイアグラム定義内で他のコマンドを同様に。
- インクルードされたファイル内。
- 設定ファイルのコマンドライン内やANTタスク内。
個別のステレオタイプ付きアクターやユースケースにそれぞれ色やフォントを定義することができます。
@startuml
skinparam handwritten true
skinparam usecase {
BackgroundColor DarkSeaGreen
BorderColor DarkSlateGray
BackgroundColor<< Main >> YellowGreen
BorderColor<< Main >> YellowGreen
ArrowColor Olive
ActorBorderColor black
ActorFontName Courier
ActorBackgroundColor<< Human >> Gold
}
User << Human >>
:Main Database: as MySql << Application >>
(Start) << One Shot >>
(Use the application) as (Use) << Main >>
User -> (Start)
User --> (Use)
MySql --> (Use)
@enduml
完全な例
@startuml
left to right direction
skinparam packageStyle rectangle
actor customer
actor clerk
rectangle checkout {
customer -- (checkout)
(checkout) .> (payment) : include
(help) .> (checkout) : extends
(checkout) -- clerk
}
@enduml
