《Clean Code》 第四章——Comment 总结

今天下午学习了下《Clean Code》的第四章,这一章总的来说还是比较简单的,里面的一些思想在前几章都有接触过。当然也从里面悟出了一些自己的体会,下面就来简单总结下。

要以代码作为注释为主体

这个小标题的意思是说,我们要尽量用代码去栓释我们索要表达的意思,基本上使用前两章所学的就可以做到了。我们要以尽量为零注释为目标,当有的通过Code Review 怎样都无法表达好的情况下才考虑添加注释。

添加注释一定要小心

当必须要添加注释时,必须要仔细思考,想出最适合的语句,千万不要让注释具有迷惑性,做到通俗易懂,简短易读(可以节省了解代码时间)。

添加对意图的理解的注释

首先要强调的是一定要尽量少的添加注释,尽量让代码说话,对于一些复杂的算法,无法通过代码清楚的表达其意思的,可以增加适当的注释。

以提升理解速度为目的

我们要明确添加注释的目的:是以提升理解速度为目的。任何注释都应该为了可以让人能够更快的读懂你的代码而存在,当然不单单是注释,我们可以通过代码来表达思想(一般这样往往更节省时间)。

TODO注释的理解

TODO注释可以标注你想要实现但是暂时没有时间去实现的代码,这样可以暂时记住你要实现的功能,方便以后实现时理解要实现的功能。但是千万不要让这些注解长期存在,因为这样会让你的代码变“坏”。既然没有时间实现,那何必要让它存在呢?

好注释之放大

注释可以用来放大一些看起来不合理的事情,这里有必要说下对于名称的命名,命名时我们要以它要做到的功能为主要参考去命名,不要过多的叙述它的逻辑等,这样会让它变得过长,读代码时产生厌烦感。如果逻辑不好表述,我们可以通过重构抽出代码,在方法名上加以叙述等。增加注释肯定是最后才考虑的。

坏代码之循规式注释

在该需要注释的地方添加注释,不要为了遵循规矩而在规矩之内的地方添加注释。

坏代码之注释掉的代码

千万别这么做,哈哈,我之前写代码,有时候就有这个习惯,修改了某个功能后,有一些代码舍不得删,总觉得以后没准还能用的上(比如用来参考)。以后改掉这个坏习惯。嘿嘿

坏代码之非本地信息

这个的意思是说,写注释时一定要阐述离它最近的代码,不要阐述与最近的代码无关的内容,其它的内容应在其它地方去考虑

小总结

在写程序时,注释是能不写就不写的,我们要尽量用代码去阐述清楚我们的思想,写注释一定要谨慎,注意以上总结的观点。我们依然要坚持一个思想,怎么写着能让人更的读懂你的程序就怎么写(重点在与快)。

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