学习日志之software engineering（10）——用文字表述UML

如何在markdown中添加uml图

在markdown中添加UML图有固定的格式，这个功能是由plantuml提供的。plantuml可以将UML语言自动转换为UML图，其转换结果可以在plantuml网站上查看。

在markdown中添加UML需要有以下格式

```plantuml

(此处添加UML代码)
```

UML基础语句有以主要有下面的语句

1. UML语句的开始和结束

@startuml
(这里添加UML代码)
@enduml

2. 对于用例图（use case diagram）

定义actor（这下面的as Men2和as Men4是这个actor的别称，可以在表示关系的时候用，就不要打那么长的字了）:

@startuml

:First Actor:
:Another\nactor: as Men2
actor Men3
actor :Last actor: as Men4

@enduml

定义use case（同样也可以用上面一样的形式定义别名）：

@startuml

(First usecase)
(Another usecase) as (UC2)
usecase UC3
usecase (Last\nusecase) as UC4

@enduml

表述各种元素之间的关系

箭头关系（由激发者指向被激发者，‘-’越多箭头上的线就越长，其实没什么卵用，这个会自动给你加长的）：

@startuml

User -> (Start)
User --> (Use the application) : A small label

:Main Admin: ---> (Use the application) : This is\nyet another\nlabel

@enduml

扩展关系（extention，可以用这个来表示，也可以用include那里的表达方式中的‘include’改成‘extend’表示，箭头指向范围广的）：

@startuml
:Main Admin: as Admin
(Use the application) as (Use)

User <|-- Admin
(Start) <|-- (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

k对k的关系（use case和class 都可以用）：

@startuml
actor user as u
actor pen as p
actor eraser as e

u "1" -- "1..*" p : own;1对1或以上
u "1" -- "1" e : own;1对1

@enduml

2. 对于类图：

class定义：

@startuml
class Dummy {
  String data
  void methods()
}

class Flight {
   flightNumber : Integer
   departureTime : Date
}
@enduml

类之间的关系表示：