代码简洁之道-->注释与格式

注释

按照代码简洁之道里面的说发,好的代码应该是没有注释的。只有表达不清楚含义,才需要用注释去辅助。
这只是理想情况,现实往往不是这样的。国人英语水平,每个人的思维方式等等这些限制条件导致我们的代码是应该有注释的。注释的规范应该是怎么样的呢?一下纯属我个人的理解。

  • 类注释
    每一个类都应该有注释,告诉别人你这个类是干什么的。
  • 实体类里的属性
    实体类里面的每一个属性都应该是有注释的,国人起得名字很难做到见名知意。
  • 方法的注释
    每一个方法最好都要做简单的说明,让人知道你这个方法干了什么。现在方法的参数多余三个以上都可能用对象了,因此在实体里面的注释也更显得有必要了。
  • 复杂逻辑的注释
    复杂的逻辑最好写一下注释,告诉别人你的实现思路。不过一定要注意,如果实现方式有改动一定要修改注释,不然就会造成注释是注释实现是实现。
格式

按照代码简洁之道的说法,代码的格式应该是团队的格式。这个应该是所有格式的大前提。如果每一个人都是一种风格,那这个代码后期的维护会是一种灾难。
对于代码的格式我做一些自己浅显的理解:

  • 团队风格统一
  • 缩进换行使用format格式化
  • 代码是有码距的,变量的申明应该最靠近使用,也就是码距最小

总结起来,注释和格式都是我们日常写代码应该注意的,从小处入手,养成良好的习惯,才能写出优雅的代码。

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

推荐阅读更多精彩内容

  • 四月,一块块田已经熟了十有八九。还有一个月就要收割,整个草原都铺满了金黄色,躺在这小山丘上,放眼望去,蓝蓝的天空与...
    文道山阅读 358评论 0 0
  • 一,系统音量获取 系统框架 获取系统音量slider 监听系统物理按键调节音量 获取系统当前音量 二,屏幕亮度 很...
    Fight_ing阅读 1,149评论 0 2
  • 各位家长:十分高兴在桥东小学与大家一起交流家庭幸福的规律,过去了两天,我们所讲的培养优秀子女的规律大家还记得吗?1...
    每个人的孟母堂阅读 248评论 0 2
  • 穿过高楼大厦,穿过桥梁村庄,穿过千山万水,在那青草更青处,油菜更黄处便是我的家。历尽艰辛,于昨日1月16日,我回...
    良柳如烟阅读 198评论 10 4