CodeReview利器-ZenUML

现状

有没有CodeView时,给别人巴拉巴拉讲了一堆,结果大多情况下只对结尾部分提问,遇到老手则会从开头部分提问。中间部分呢?看大家表情就知道,都没跟上思路。

这里需要个图

受不了的程序员,则会提出要求:这段逻辑超过3个流程,需要个图来帮助大家理解。

不用了吧,代码都实现了,还用画图?

画图这件事,轮到别人使劲往上推,轮到自己使劲往外推。

为什么画图这么反人性?

  1. 程序员写代码用IDE,画图需要打开另一个软件,切换麻烦,不符合这个标准
  2. 代码没写前,图上画什么呢?就算画上八成也会再改,更不符合都标准
  3. 代码写好后,画起来也别扭,位置挪来挪去始终不满意,画完也没有成就感

为了解决第1个问题,主流的IDE都通过插件的方式支持了画流程图的功能,如MarkDown插件本身就有flow的功能,还有增强的PlantUML基本能满足大部分要求。

还是不好用

  1. 这些flowPlantUML画起来太麻烦,一条线得用十几甚至几十个字母,而且整块代码有大量重复,透着浓浓的坏味道
  2. 那使用直接从源码生成的调用关系图?可以想象这样生成的图要么太大,要么太乱,况且我们只需要画代码中的一部分流程,生成的图一般不可能凑巧把我们需要的部分画在一起

画图能做到零负担吗?

  • 思维不能切换,主线是代码思维,不能因为画图而出去
  • 不能比实现代码增加任何东西,多一个单词都是一种罪恶
  • 不能花太多时间,超过1分钟的事都会引发严重的拖延症

ZenUML

主角登场了,直接上例子,就拿上周做的FizzBuzz来展示。
画图的源码如下:

  • 全部是伪代码表示
  • 关键的模块和接口可以和实现代码复用
  • 对于已经实现的代码,再用伪代码复制一次,如这个例子可以在1分钟内完成
@Starter(main)
ruleSet = RuleSet.all() {
  DivideRule.create(3, Fizz)
  DivideRule.create(5, Buzz)
  ContainsRule.create(3, Fizz)
  ContainsRule.create(5, Buzz)
}

game = new Game(ruleSet)

game:Game.play(count) {
  for (i < count) {
    item = new FizzBuzz(i)
    result = item:FizzBuzz.apply(ruleSet)
    println(result)
  }
}

item:FizzBuzz.apply(ruleSet) {
  atomicResult = ruleSet.apply(i)
  componentResult = reduce(atomicResult)
  result = getOrElse(componentResult, defaultResult)
}

渲染效果


main
FizzBuzz.apply

如何使用?

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容