代码注释的重要意义

有时候,我们的开发者要完成某个功能的编码实现,或许灵光一闪,犹如行云流水,一气呵成,看着长长的整洁的代码总是忍不住津津乐道,就是懒得给这代码添上几行注释。过几天,或者过了一段时间之后,代码需要改动,还得花时间重新理解这段代码,改动需要10分钟足矣,但是阅读这段代码可能需要花上半个小时或者半天的时间,如果这代码是由别的程序员来阅读,花的时间必定会更长。不写注释,不利于日后工作的进展,也不利于日后工作的交接。

百度、google了一下都没有详细说程序注释的意义相关的文章,只搜到一些不写注释带来的影响,诸如此类:

给代码写上工整的注释是一个优秀程序员的良好习惯。工整简洁的代码未必就有较高的可读性,在一些业务比较繁琐,参数比较多的函数中,阅读代码的人会在各种参数的用法中纠缠不清,但是如果在参数或者业务操作的代码旁加上工整的注释,可以让既有的代码脉络清晰,更加有血有肉。如下图所示:

注释是程序员之间交流的通道。我们在欣赏古诗词的时候,难免也会遇上一些抽象难懂的字、词、句,然而,书本一般都带有注释,这是为了让读者更好地去想象创作时的场景,更好地去理解创作者的思想感情,然后设身处地陶醉一番。读者自然不吝赞美之词。我一直认为,代码如诗,写代码就好比吟诗作对。但是单纯的代码并不能完全使得程序的思想被其他人所理解,更有甚者,还会被咒骂。代码中的某些参数,就像上文提及的“字”;代码中的某些行,就像上文提及的“词”;代码中的某些函数或者某些代码块,就像上文提及的“句”。有了注释辅助,读者可以自行理解代码的实现思想,就不必手足无措地找人询问,大大节省时间成本,也可更专注在工作上。

上图的注释清晰反映了函数与代码上下文的关系,这么贴心的注释,使得读者在茫茫代码之中不必为了查找某个参数或者某个方法而上上下下地翻动滚动条,不至于让读者在翻查代码的过程中丢了工作的热情。

注释是程序员个性的反映。大家都有各自的编码习惯和注释风格,喜欢在注释里面署名的程序员,个性比较张扬,无论是对生活还是对工作都是乐观积极,团队中的活跃分子;喜欢用符号框住注释的程序员,拥有谦虚得体的个性,工作生活中不骄不躁,传递着正能量;喜欢把注释围成图案的程序员,内心想法丰富多彩,无论是工作还是生活都不缺乏艺术范。可见,注释也是程序员得以展现自我的舞台。

注释有利于节约公司的资源。程序员的工作很多时候会交接给新的职员来进行,新职员往往会耗上一段较长的时间去阅读代码,这个过程难免会经常询问同事有关问题,间接或直接影响到同事工作状态。注释可以大大降低问题的发问率,并且引导新职员去理解代码,同时节省了时间,而时间就是金钱。

看过软件工程相关教材的都有所了解,几乎每一本教材都告诉我们写代码要加注释,并且要学会高质量的注释,因为代码不仅仅是用来执行的,它还是用来给别人看的。好的代码加上高质量的注释,使得程序尽显优雅,读的人赏心悦目,何乐为不为呢?

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,585评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,401评论 25 707
  • ——流浪涛 一次不经意的邂逅 目睹了你绚丽的容颜 在阳光的沐浴下 娇艳欲滴 香雾蒸腾 一阵微风吹来 你花枝乱颤地舞...
    流浪涛阅读 646评论 0 3
  • 最后两张因为原图太大,只能发这种缩略图啦! 希望大家喜欢!
    月月_1994阅读 699评论 15 10
  • 《MONSTER》是浦哲直树的作品,因为标题去看的漫画,看完之后很喜欢,除了结尾力道略显不足之外,这真的是一部好作...
    珊瑚赫阅读 580评论 0 0