代码整洁之道(整理三:注释)

背景:接上回。上回说的是函数,这回说注释。

总结提前:注释这里能说的很简单:大部分的注释都是low的,都是无用的,都是废话。能不写尽量不写。

  1. 别给糟糕的代码写注释,重新写吧!
  2. 什么也比不上放置良好的注释来的有用。什么也不会比乱七八糟的注释更能捣乱。什么也不会比陈旧、提供错误信息的注释更具有破坏性。
  3. 注释并不“纯然地好"。很多时候,注释是一种恶,如果代码有足够、清晰的表达意图,就不需要注释。注释只能说明我们代码表达意图的能力的失败,因为你发现你的代码既然需要注释才能让人看懂,这并不值得庆贺。
  4. 如果你发现自己需要写注释,你应该从优化代码表现力层面来解决。

一、为什么注释这么坏
1、因为注释会撒谎。不是说总会撒谎,但是很多情况下会这样,注释存在的时间越长久,就离所描述的代码的本意越远,原因很简单,程序员不会坚持对注释进行维护。
2、代码会变动、会变迁。会分离、重造,但是注释不能总是随之变动,不能总是跟着走,会越来越不准确。

虽然说程序员应当负责将注释保持在可维护、有关联、精确的高度。但是,更主张把力气用在写清楚代码上,直接保证无需写注释。

不准确的注释要比没有注释要坏的多。永远只有代码能忠实的告诉你它做的事情,那是唯一准确的。

喃喃自语的注释,每个过程都添加注释,有时间写这么多注释,你不如打磨一下代码。

二、注释不能美化糟糕的代码
带有少量注释的整洁而有表达力的代码,要比带有大量注释的零碎、复杂的代码像样的多。

三、并不是说注释全是坏的
1、比如警告:警告看这个代码的人,为什么要这么写,这个的重要性。
2、tod注释。
3、公共api的javadoc。因为这个是公开的,别人不会看你的代码,只需要知道怎么用就可以。
4、注释调的代码的注释。注释调一段代码,必须写注释,说明出于什么原因注释这段代码,否则,后人不敢动这个注释的代码,到时候,这些代码堆积在一起,就会很乱。

四、多余的注释
1、误导性的注释。既然觉得写注释,你的注释一定要让人很容易看懂,否则别人看半天,浪费时间不说,还起到误导的效果。
2、每个函数每个变量甚至每个过程都写注释,更是可笑的。这会让代码变得很散乱。
3、日志式注释。
每个人修改过这个方法,都写一个注释上去。这个也有点可怕。

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

推荐阅读更多精彩内容