plantUML最佳实践

# plantUML

===========================================================

 

使用plantUML中的活动图用来画流程图很好用; 但类图等就不很好用; 个人体会如下:

 

• 时序图 **推荐**

• 用例图 **一般**

• 类图    **不推荐, 用Visual Paradigm或StarUML更好**

• 活动图 **推荐** 

• 组件图 **一般**

• 状态图 **不推荐, 用visio更好**

• 对象图 

• 部署图 

• 定时图

 

## 部署

- 下载plantuml插件

- 安装Graphviz

    - 可以使用scoop安装: scoop install graphviz

 

## 工具

- plantuml规范的pdf，当做手册随用随查；

 

## 使用经验

- 建议在项目开始时建一个开发文档文件夹；

    - 里面的.plantuml文件建议用用中文命名，比较容易看；

- 一个文件中可以写多个图；只需用@startuml, @enduml围起来即可；

    - 使用VScode PlantUML(jebbs)插件，鼠标停在哪个图的代码里就预览哪个代码的图；