工作中完成一个项目之后往往会花一些时间编写文档,画程序流程图。这样的好处是方便交接项目,后续也能够快速回忆。画流程图的软件有很多, 比如常用的Process,百度脑图,缺点是流程图只能以图片保存放到代码目录中,后续更改很麻烦。
这里参考Buildroot 开源库中使用的工具Graphviz ,根据相应的规则自动生成流程图。
Graphviz简介
Graphviz(英文: Graph Visualization Software的缩写) 是一个由AT&T开发的图形绘制工具,用于绘制DOT语言脚本描述的图形。支持多种格式输出,在windows、Linux、Mac上都可以顺利运行。
安装
Ubuntu或Debian下安装很简单
sudo apt-get install graphviz
使用示例
Dot是开源工具包Graphviz上用来画图的一门脚本语言。通过布局引擎解析脚本得到图像,然后可以将图像导出为各种格式以满足需求。有了它,我们就可以很方便地通过编写脚本来画各种结构示意图和流程图。
第一步: 编写以dot为后缀的文件hello.dot
digraph { hello -> world;}复制代码
第二步: 使用dot命令编译
dot hello.dot -T png -o hello.png
完整的命令为:
<cmd> <inputfile> -T <format> -o <outputfile>
-T png 表示输出格式为png,可以设置的格式有pdf、svg、gif、dia等格式
第三步: 最终结果
实际过程中画流程图往往根据项目的实际情况, 这里提供一些基础的例子供参考.
例子1 : 简单有向图
digraph graphname{ // 定义有向图,graphname表示图的名字 a -> b; //定义一个有向边,它从起始指向结束节点 b -> c; a -> c;}复制代码
编译生成
例子2 : 带标签的简单有向图
digraph graphname{ T [label="Teacher"] // node T P [label="Pupil"] // node P T->P [label="Instructions", fontcolor=darkgreen] // edge T->P}复制代码
编译生成
例子3:同样的图,不同的形状和颜色
digraph graphname { T [label="Teacher" color=Blue, fontcolor=Red, fontsize=24, shape=box] // node T P [label="Pupil" color=Blue, fontcolor=Red, fontsize=24, shape=box] // node P T->P [label="Instructions", fontcolor=darkgreen] // edge T->P}复制代码
编译生成
例子4 : 定制模板
单独地去定义每一个节点其实很浪费时间的,这个模板会让你事半功倍。
digraph hierarchy { nodesep=1.0 // increases the separation between nodes node [color=Red,fontname=Courier,shape=box] //All nodes will this shape and colour edge [color=Blue, style=dashed] //All the lines look like this Headteacher->{Deputy1 Deputy2 BusinessManager} Deputy1->{Teacher1 Teacher2} BusinessManager->ITManager {rank=same;ITManager Teacher1 Teacher2} // Put them on the same level}复制代码
编译生成
关注程序手艺人,订阅号中输入流程图模板关键字,获取更多的参考模板。