注释并不是纯然的好

注释并不是纯然的好

   “代码与注释”的关系,我诚然的多次听到这样的一种说法,“尽量每个函数,都写上详细的注释,这样以后别人接收就很容易理解。”其实,这样的说法存在弊端。

     首先要明确一点,注释到底是干什么用的。注释的恰当用法是弥补我们用代码表达意图时遭遇的失败。换句话说,有意义的命名才是根本之道,如果我们无法准确的找到有意义的命名,那么注释可以增加代码的可理解性。注释不可以滥用,也不可以过度的依赖注释。其实,我一直认为,代码根本不需要注释,因为注释存在,是因为我们找不到对命名的良好表达方式。注释可以说是一个补救措施。

     注释的有点是,增加可读性与可理解性。

  注释的缺点是:可能因多个程序员的改动,造成注释内容陈旧,提供错误信息。

     我一直不建议写注释的原因,是因为注释会说谎。一:就算是注释,汉语的表达也可能存在词不达意的情况。二:代码在变动,在迭代,在修改,不幸的是注释并不总是随之变动。我们不可忽略的一点是,注释存在的时间越久,就离其所描述的代码越远,也许是全然的错误。为什么我不建议写注释,很简单,随着人员的流动,项目的高速迭代,程序员能不能坚持长久的维护注释,谁也不能保证。

    我们应该尽量做到,准确的命名,真正好的程序员是找到困难的解决方案,尽量不去写注释。

   说了注释的很多缺点,其实注释本身没有错,错的是我们使用它的时机与地方。比如,警示的作用。如:“// 在此处共花费时间26小时”。这个就相当的有用,因为其他程序员看了,就知道,业务逻辑复杂,修改时候要细心,多琢磨一下。

   什么也比不上良好的代码有用,什么也不会比乱起八糟的注释更有本事捣乱,什么也不会比陈旧,提供错误信息的注释更有破坏性。适当的时机,适当的位置使用注释,可以事半功倍。用错了,会浪费开发时间,影响项目进度。

  注释并不是纯然的好。

阅读原文

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,580评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,386评论 25 707
  • error code(错误代码)=0是操作成功完成。error code(错误代码)=1是功能错误。error c...
    Heikki_阅读 3,350评论 1 9
  • 从今年的三月到现在,我一共瘦了十二斤。我把这个消息公布在朋友圈以后,除了“一方有难,八方点赞”的损友党,大部分女孩...
    XSP薛老爷阅读 189评论 0 5
  • 《头脑特工队》这是一部非常好看的电影,用动画片的方式描述了人的各种情绪如何进行分工合作。 今天重新听了冰冰老师的《...
    雷清凤阅读 305评论 0 2