Project_OKI’s diary

エンジニアの勉強ブログ

Doxygen7(PLANT UMLでシーケンス図作成)

 

・目次

 

 1.目的

 ・PLANT UMLでシーケンス図を作成する基本的な方法について記載する。

 

2.シーケンス図とは

  ・システムの流れを、図面化し視覚的に分かりやすく表したもの。

詳細:シーケンス図とは? 書き方のポイントや例、作成に便利なツール

 

 ・PlantUMLによるシーケンス図は、下記サイトで作成可能。

 →PlantUML Web Server

 

3.PlantUMLでシーケンス図作成

 3.1 基礎1

@startuml
activate Obj1
Obj1 -> Obj2 : 処理1

activate Obj2
Obj2 ->Obj3 :処理2

activate Obj3
Obj3 ->Obj2 :応答2
deactivate Obj3

Obj2 ->Obj1 :応答1
deactivate Obj2

@enduml

出力結果:PlantUML Web Server

説明

 (1) activate Obj2

 →activate xxx(オブジェクト、クラスなど) の実行している間を示す。

 (2)deactivate Obj2

 →deactivate xxx (オブジェクト、クラスなど)の、 実行終了を示す。

 (3) Obj1 -> Obj2 : 処理1

 →オブジェクト名 -> オブジェクト名によって、オブジェクト名と矢印が表示される。

  :処理1によって、矢印の上に、処理の名前などが表示される。

 

 3.2 基礎2

@startuml
activate Obj1
Obj1 -> Obj2 : 処理1

activate Obj2
Obj2 ->Obj2 :処理2

Obj2 ->] :処理3

Obj2 ->Obj2 :処理4

Obj2 -->Obj1 :応答1
deactivate Obj2
@enduml

出力結果:PlantUML Web Server

 

 (1) Obj2 ->Obj2 :処理2

 → 同じオブジェクト名にすることにより、処理がそのまま返る。

 (2) Obj2 -->Obj1 :応答1

 → -->を使用することにより、線が点線になる。

(3) Obj2 ->] :処理3

 → 枠外への矢印を表示。

 

3.3 基礎3( 条件分岐とループ)

@startuml
activate Obj1
Obj1 -> Obj2 : 処理1

activate Obj2
Obj2 ->Obj3 :処理2

activate Obj3

alt true
 Obj3 ->Obj2 :応答2
else false
 Obj3 -> Obj3 :処理1
 Obj3 ->Obj2 : 応答2
end
deactivate Obj3

Obj2 ->Obj1 :応答1
deactivate Obj2

loop 3count
 Obj1 -> Obj1 :wait100ms
end
@enduml

結果:PlantUML Web Server

(1) alt true:条件分岐を示す。

 alt 条件、else  条件、end(条件終了箇所) と記載する。

 今回の場合は、trueの場合は、応答2を返す。

 falseの場合は、処理1を行ってから、応答2を返す。

 

(2) loop 3count:ループ処理を示す。

 今回の場合は、100msを3回繰り返すという意味になる。

 

関連記事

ソフトウェア資料作成

Doxygen1(Doxygenの魅力と活用法) - Project_OKI’s diary

Doxygen2(Doxygenの導入及び使用方法) - Project_OKI’s diary

Doxygen3(Javadocのコメント) - Project_OKI’s diary

Doxygen4(DoxygenでGraphwizを使用) - Project_OKI’s diary

Doxygen5(ファイルと関数のコメント) - Project_OKI’s diary