Plantuml Cheat Sheet

Posted : admin On 1/24/2022
  1. Plantuml Sequence Cheat Sheet
  2. Plantuml Cheat Sheet
  3. Plantuml Comment Syntax
  4. Plantuml Guide
  5. Plantuml Comment

PlantUML is a component that allows to quickly write.This is cheat sheet of PlantUML to use frequently.

PlantUML is a component that allows to quickly write. This is cheat sheet of PlantUML to use frequently. PlantUML Language specification Sequence Diagram. Donate 258 Patreon 127. Sequence Diagram. Basic examples The sequence - is used to draw a message between two participants. Participants do not have to be explicitly declared. To have a dotted arrow, you use - It is also possible to use.

Common

Notes and Comments.

keywordusageimage
titleTitle
note left :Notes Left
note right :Notes Right
' Single-line Comment
/' '/Block Comment

Code

Draw

Participant

Participant actors.

keywordusageimage
actorActor
boundaryBoundary
controlControl
entityEntity
databaseDatabase

Code

Draw

Arrow

Arrow direction.

keywordusageimage
-up->Up
-down->Down
-left->Left
-right->Right

Code

Draw

Use Case

Represent the required functions.

keywordusageimage
( )Use Case
->Use
.>Extend, Include
Plantuml Cheat Sheet

Code

Draw

Activity

Represent the state of the process.

Plantuml Cheat Sheet
keywordusageimage
' 'Activity
(*) ->Initial
-> (*)Final

Code

Draw

State

Represent the state of the objects.

keywordusageimage
[*] ->Initial
-> [*]Final

Plantuml Sequence Cheat Sheet

Code

Draw

Plantuml Cheat Sheet

Sequence

Represent the messages and orders of the interacts.

keywordusageimage
->Message
<--Return

Code

Draw

Object

Represent the logical view of the object.

keywordusageimage
objectObject
< -Extension
*-Composition
o-Agregation

Code

Draw

Class

Represent the logical view of the class.

keywordusageimage
classClass
+Public
-Private
#Protected
~Package

Code

Draw

Component

Represent the dependency of the components.

keywordusageimage
[ ]Component
packagePackage
frameFrame
folderFolder
databaseDatabase
nodeNode
cloudCloud

Code

Draw

Colors

Sequence

We can add colors to Arrows, Icons, Sprites, Components, Packages, etc.PlantUML support Hexadecimal colors or colors that are already defined.

Site Reference: http://plantuml.com/skinparam

Plantuml foreach

Code

Draw

Legends

Legend can contain only text, or some tables.This example contain a table with some HTML inside and OpenIconic.

OpenIconic Reference: http://plantuml.com/openiconic

Code

Draw

Constants

It’s possible to declare constants that will help us for example to include files or other *.puml

PS: when you use it remove ${}, thats only there for the example

Plantuml Comment Syntax

Code

Plantuml Guide

Sprites & Includes

Plantuml Comment

There are a lot of useful sprites and images that we can use.In the next example you have all the ways to implement components using this open source library.

Code

Draw