读书笔记--修改代码中的艺术

好久没有写读书笔记了,说来惭愧。最近一直在整理项目文档交接的事,感觉智商不够用。相信大家在理解别人写的代码的时候都有过这种经历,这块逻辑在干吗?这个算法解决了什么......一万个为什么在脑海中闪过。

一般来说,代码是对业务逻辑更高级的抽象描述。脱离实用场景和业务,代码只是一堆没有任何意义的散沙。那么在原有逻辑缺失,能不能从代码中去推导出原有的业务逻辑呢?难,然而我正在接收这样的考验。

下面是我反推逻辑时产生的一些想法:

1.必要的注解还是很有必要的。代码是凝聚了程序员的智慧。思想很抽象,每个人都有看问题的不同之处,当然也就有不同的解决方案。怎样帮助其他人更好的理解这块逻辑,除非你们思考的一样(哲学上说没有两片叶子相同)。虽然经过大量的时间理解了写的算法,并对作者的思维方式赞不绝口。可是换个角度这样的时间成本是否值得?读者又得到了什么?同样场景下的同样业务还会再次发生吗?也许一个简单的备注说明它处理什么,收效会好很多。

2.相信代码中的存在即合理。程序中的每一行代码都有存在的理由。对于没有产生作用的代码要及时的清理。就像建造一个大楼一样,每块砖都是一个必要的单元。多余的砖对于建造者来说无可厚非,不影响整体的稳定,留着就留着。但是对于参观者来说,那是不是艺术家故意为之的呢!为了增加美感而不能缺少的部分!当我们很仔细的了解了那段代码后,发现这部分在很长一段时间随着业务的调整就弃用了,但是代码保留了下来,这对于其他人来学习真是个悲伤的故事。及时clean code很有必要,让每行代码都有存在的依据。

3.文档的更新。上面说到代码依靠业务,业务需要文档来进行整理、存档,保留智慧。然而在teamsite上发现的都是最新的业务解释文档。这一做法很好,很方便新的业务人员及时了解项目的进展。但是对于开发人员来说,效果也许就没那么好了。代码是很容易看出历史痕迹的。毕竟从文档产生的第一天起,相关代码就开始随之生成。如果业务变化了,而相关代码没有及时的清理更新(在现实生活中很常见),历史遗留的代码就缺少了存在的依据。对于理解代码的同学来说也是灾难性的打击。那么有没有方法避免呢?我想到的一个办法就是让文档也具有历史性,每有一次新的业务,就生成一个新的版本。v1、v2、v3......

4.及时请教当事人。当理解完一段代码后,如果能找到当时写的人更好,找不到也要找找曾经参与的人帮助你检验下你的理解是否正确,能不能简单的还原出当时的场景。一个人的理解能力毕竟有限,特别是在对业务不熟悉的情况下,很容易就走向偏路。及时的沟通,就像敏捷迭代那样,真理也不是一个人慢慢的领悟出来的,都是在一次次的碰撞中形成的。

5.必要的流程图释义。对于一个细小的模块,代码足够清晰,流程图是没有存在的必要的。但是对于一个大的业务流水线,流程图就显得至关重要了。制作工艺也是先有图纸,要是看别人的代码有指导性图示解释,想想都觉得很美好。

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

推荐阅读更多精彩内容