代码整洁之道—注释

别给糟糕的代码加注释——重新写吧

若编程语言有足够的表达力,就不那么需要注释——也许根本不需要。

注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败,注意,失败。注释总是一种失败,我们总找不到不用注释就能表达自我的方法,总要有注释,这并不值得庆贺。每次写注释,你都该做个鬼脸,感受自己在表达能力的失败。

注释不能美化糟糕的代码,与其花时间编写解释你搞出的糟糕代码的注释,不如花时间清洁那堆糟糕的代码,写出整洁而有表达力的代码。

好注释

  1. 法律信息
    有时,公司代码规范要求编写与法律有关的注释。IDE会自动卷起这些注释
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
  1. 对意图的解释。
    有时候稍微解释一下,自己某段程序准备做什么操作。

  2. 提供信息的注释

// 格式化匹配的  kk.mm.ss EEE, MMM dd, yyyy
Pattern timeMatcher = Pattern.compile(
"\\d*:\\d*:\\d* \\w*, \\w* \\d*, \\d*"  );

也可以把这段代码移动到某个时期和时间格式的类中,可能会更好和更清晰。

  1. 警示
    // 除非你必须要杀掉某些东西,否则则不要运行这段程序

  2. TODO 注释
    // TODO是一种程序员认为应该做,但是由于某些原因目前还没有做的工作。
    目前,大多数好IDE都提供了特别的手段来定位所有的TODO注释。

  3. 说明重要性
    // 本次操作非常重要,它去除了字符串两边的空格

如果你决定写注释,那么就花必要的时间确保写出最好的注释。

坏注释

  1. 喃喃自语

  2. 多余的注释,废话的注释。

  3. 误导性注释

  4. 循规蹈矩式注释
    例如,要求每个函数都要写javadoc,就会得到很多原本无需写注释的注释。

  5. 能用函数或变量时就别用注释。

  6. 位置标记
    有点程序员喜欢在源代码中标记某个特别的位置。少用这种无理,鸡零狗碎的注释。
    // Actions ///////////////////////////

  7. 注释掉的代码。
    有些已经不用的程序,依然被注释在哪里,有的人可能回想代码留在哪里也许会有用。但是我们现在有源代码控制系统,无需再用注释来标记,删掉即可。

最后

还是要记住,写程序不仅仅是为自己而写,考虑到读到你写的代码时的感受。不要喃喃自语,清晰的用程序语言表达自己

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

推荐阅读更多精彩内容

  • 别给糟糕的代码添加注释——重新写吧。 若编程语言足够有表达力,或者我们长于用这些语言来表达意图,就不那么需要注释—...
    清风流苏阅读 889评论 0 2
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,816评论 18 139
  • 目录及笔记链接 序 丹麦谚语:小处诚实非小事。 建筑师路德维希:神在细节之中。 日本的 5S 哲学: 整理(整理、...
    小镭Ra阅读 1,501评论 3 3
  • 前段时间在看这本书, 看了一大半了, 很多东西讲的还是很有道理的, 这一系列文章作为笔记, 供自己今后翻阅. 1....
    Dev_hell03W阅读 412评论 0 0
  • 浩浩是我的小孙子,4周5个月了,1周岁开始喝黑茶了,身体状况很好,一直以来没有吃过药,没有打过针,真的很幸运,在幼...
    黑茶玲玲阅读 446评论 6 7