Clean Code

1. 整洁代码

什么是整洁代码 :可读性;可维护性;可拓展性;高效性
为什么需要保持代码整洁 : 混乱代码付出的代价高昂,时间成本,人力成本

Clean Code 谨记两个原则 :

  • 勒布朗法则 : Later equals never
  • 美国童子军军规 : 让营地比你来的时候更干净

2. 命名

2.1 有意义的命名,通过命名可以知道变量或函数的作用

code once, read more 好命名带来高效率

2.2 采用统一的命名方式

  • 驼峰命名法 : UperCamelCase(大驼峰); lowerCamelCase(小驼峰)
  • 匈牙利命名法:在大驼峰的基础上,加上前缀,前缀用来表达类型或用途

2.3 避免命名之间的混淆,做有意义的区分

  • 理清函数层次关系,赋予一个准确的名字,是十分有必要的

3. 注释

When I wrote this, only God and I understood what I was doing
Now, Only God knows

什么是最好的注释 : 没有注释!!!

糟糕的代码是注释存在的动机之一,代码在变动,在演变,不准确的注释比没注释更加糟糕,最优解那就是通过代码自注释!!!

必须写的注释 :
  • 版权信息: Copyright ... ...
  • 对外API的描述
  • 警示
  • 等等
坏的注释 :
  • 函数的注释,貌似很全,但是参数的含义啥都没说明,注释等于没用
  • 多余的注释
  • 没有同步更新的注释,容易造成误导
  • 等等
关于注释的几项意见
  • 注释务必要准确
  • 注释需要与代码同步
  • 除非必要,尽量代码自注释

4. 格式

格式的目的

对代码采用一致的格式,这不是浪费时间的愚蠢修饰,而是一种重要的交流工具

  • 4.1 概念间垂直方向上的区隔
    在阅读代码的时候,我们的视觉总是很容易停留在空白行后的第一行。那么,我们可以利用此行为习惯标识重点、将代码中的功能区分隔。比如:函数申明、变量定义、各个细节功能、函数之间、重要的算法都建议使用空白行进行标识。
  • 4.2 垂直方向上的靠近
    在如果说空白行隔开了概念,靠近的代码则暗示了它们之间的紧密关系。所以,紧密相关的代码应该互相靠近。
  • 4.3 相关的函数紧密相连,方便阅读分析代码
    概念相关的代码应该放在一起。相关性越强,彼此之间的距离就该越短。
  • 4.4 垂直顺序
    一般而言,我们想自上而下的展示函数调用顺序,被调用的函数应该放在执行调用函数的下面,这样我们就建立了一种自顶向下贯穿源代码模块的信息流。
  • 4.5 保持代码行短小
    代码行尽量不要超过80个字符
  • 4.6 水平方向上的区隔与靠近,对齐,缩进

每个程序员都有自己喜欢的格式规则,但在一个团队中,需要统一团队编码格式

5. 函数

  • 5.1 函数就该短小
    20行左右的代码最佳

维护成本小
代码可读性好
拥有重用潜力
灵活性好,易于重构
代码质量高,错误无处遁形
最小化注释

  • 5.2 单一职责原则
    函数应该做一件事;做好这件事;只做这一件事.

  • 5.3 函数参数
    参数越少越好 : 参数过多就封装成结构体

  • 5.4 DRY --- Don't Repeat Yourself
    重复可能是软件中一切邪恶的根源
    函数最小化,提高重用性
    拒绝拷贝,坚持重构,从点滴做起

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

推荐阅读更多精彩内容

  • 整洁代码 代码呈现了需求的细节。将需求明确到机器可以执行的细节程度,就是编程要做的事。而这种规约正是代码。 勒布朗...
    在路上_80f5阅读 781评论 0 0
  • 0. 内容提要 软件质量,不但依赖于架构及项目管理,而且与代码质量紧密相关。 代码质量与其整洁度成正比。干净的代码...
    nimw阅读 3,915评论 0 3
  • 代码整洁之道 Clean Code 第一章 整洁代码 代码的重要性我们永远抛不掉代码,因为代码呈现了需求的细节。在...
    Pengzh1阅读 1,216评论 0 1
  • clean code,顾名思义就是整洁的代码,或者说清晰、漂亮的代码,相信大多数工程师都希望自己能写出这样的代码。...
    楚简约阅读 918评论 0 0
  • *本文系转载 clean code,顾名思义就是整洁的代码,或者说清晰、漂亮的代码,相信大多数工程师都希望自己能写...
    盗梦49阅读 404评论 0 1