技术管理篇6一高质量编码

前面几篇,我们一直在讨论怎么做好系统的架构设计。架构设计很重要,但是如果代码编写的不好,那再好的设计也是白费。今天,我们来聊聊编码过程中,需要注意哪些问题。

我觉得代码编写过程中,有两个方面需要额外的注意,一个是代码的健壮性,一个是代码的可维护性。

健壮性

先说一下健壮性,简单讲就是代码在边界条件下的表现如何。大部分人写代码,一般只会考虑正常的逻辑情况。但是,一个优秀的工程师,主要是看他对边界条件的理解。

什么是代码的边界?我们可以把计算机系统抽象为针对用户的输入,经过逻辑处理,给出相应的反馈。那我们就可以在输入、逻辑处理、反馈三个阶段来考虑边界。

在用户输入阶段有哪些属于边界,我们可以去思考。比如用户的输入有没有特殊的字符或者极限值。再比如极端情况下,有多少人同时在请求系统等等。

在逻辑处理阶段呢,比如极限情况下有多少数据量需要处理,以及运算所需的时间和空间成本如何,异常的数据怎么处理,当硬件资源出现问题的时候又需要怎么处理等等。

在给出反馈阶段呢,比如特殊情况下如何反馈给用户,极端情况下的数据能否展示出来等等。

大家可以看到,这三个阶段都可以认真的去考虑。你把边界条件考虑的越详细,代码的健壮性就越高。无论出现什么状况,系统就越稳定。

举个实际代码编写的例子,当我们写一个函数的时候,有输入参数,也有输出参数。如果不对输入参数进行必要的校验和判断,就直接使用,这样的代码在边界情况下就很容易出问题。

再比如,在编写业务逻辑的过程中,我们采用了一种数据结构和算法。这时候,我们就需要考虑这种数据结构和算法在大数据量、大并发的情况下表现如何,时间和空间成本分别是什么样的等等。

如果不提前考虑这些问题,在真正实际应用的过程中就会碰到各种意想不到的状况。

可维护性

业务在不停的变化,相应的支撑系统就要不停的更新和维护。代码的可维护性决定了一个系统生命周期的长短。那怎么做好可维护性呢?

我觉得首先要解决一个思维模式的问题,写代码并不是完成任务就可以,本质是在交付一个产品。就是要拿产品交付的心态去写代码。

什么是产品交付心态,就是首先考虑真实用户的感受。也就是说在写代码的时候,就要考虑其他人需要理解我的代码,需要修改或者扩展我的代码,他的感受是什么样的,我如何让他更方便。

有了这个心态,其他的事情就顺理成章了。要不要写注释,那就看一下当前这段代码好不好理解了,如果不好理解,那就必须要写注释。要不要为变量起一个好的名字等等,你会发现当你换一个心态在做的时候,这些抉择就变得很自然。

其次就是要有一个基本的评判标准,到底什么样的代码就算是易于维护了。我觉得越简单的事情越容易被人理解,也就越容易被维护。

我们一定要尽可能的保持逻辑的简洁性。比如一个方法就只能完成一件事情,代码行数不能过多。一个类就只能承担一个对象的职责,不要试图让他做无关的事情。简洁算是基础的一种评判标准。

代码品味

无论是代码的健壮性还是可维护性,都很难有唯一、可量化的标准,很难简单的去管理或者检查。他更多的是一种编码的习惯,对每个人来说都不是一蹴而就的。都需要我们对自己有很高的要求,经过长期的刻意练习,才能达到。

怎么能持续的坚持下来,养成一个好的代码习惯呢?我觉得首先我们自己得重视这个事情,整个团队氛围也要重视这个事情。甚至在团队中养成一种代码的品味,每个人都养成这样的品味,这样才能持续的把这个事情做好。

总结一下,好的代码要有健壮性和可维护性,尽可能的考虑代码的边界情况,让代码的组织足够简洁,持续的产品交付,最终形成我们自己的代码品味。

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

推荐阅读更多精彩内容

  • 1.测试与软件模型 软件开发生命周期模型指的是软件开发全过程、活动和任务的结构性框架。软件项目的开发包括:需求、设...
    Mr希灵阅读 21,955评论 7 278
  • 故事全篇:《妖说妖话之梦未央》目录 上一篇:《妖说妖话之梦未央》十八、吵架好幼稚 生活好像一成不变,又好像已...
    慕颜未央阅读 342评论 0 0
  • 一个青年去寻访住在深山里的智者,想向他请教一些人生问题。 “请问大师,在人的一生中哪一天最重要?是生日还是死日...
    陈柚润阅读 430评论 1 0
  • 我和玉蘭樹之間 隔著開滿花的窗子 玉蘭花瓣散落隔著滿天的繁星 找你 打馬放歌 獨自征戰雲霞的日子 有無邊無際的歡喜...
    小丝游江阅读 241评论 0 1