测试PlantUML最简单的方法是在一个嵌入了PlantUML的在线解决方案中,比如我们的
在线服务器。
当您对PlantUML有了基本的了解, 就可以在本地安装和使用PlantUML了。
如果安装和使用中遇到任何问题,可以先尝试在这里找找答案(
FAQ)。
软件要求:
- Java: 是运行PlantUML的必需条件, 请在您的环境中安装Java。
- graphviz-dot: 可选的, 但是建议安装 (如果想绘制除 时序图和活动图以外的图, 就需要安装 Graphviz 软件)。
从下载适合您当前操作系统的graphviz软件包, 安装或者解压到你指定的目录。
然后需要设置系统环境变量,命令窗口中输入"sysdm.cpl"›高级›环境变量。建立变量名GRAPHVIZ_DOT,值为刚才安装的路径。
接下来, 需要下载
plantuml.jar 文件, 保存到本地安装目录。
WARNING
This translation need to be updated. WARNING
使用PlantUML的
命令行语法,
将其包含在你自己的脚本或文档工具中。
- 用PlantUML命令创建一个文本文件,就像这个例子一样,叫做
sequenceDiagram.txt
。
@startuml
Alice -> Bob: test
@enduml
2.运行(或让你的软件调用)PlantUML,使用
sequenceDiagram.txt
作为输入。输出是一个图像,它或者出现在其他软件中,或者被写入磁盘上的图像文件。
例如。
java -jar plantuml.jar sequenceDiagram.txt
这将你的序列图输出到一个叫做
sequenceDiagram.png
的文件中。