代码简洁之道

第一章 整洁代码

第二章 有意义的命名

  • 名副其实

问题不再于代码的简洁度,而在于代码的模糊度。即上下文在代码中未被明确体现的程度。

  • 避免误导

1、应当避免使用与本意相悖的词。
例如 accountList 来指称一组账号,除非他真的是List类型,List对程序员有特殊意义。所以accountGroup或者bunchOfAccounts,甚至用accounts都会好一些。
2、提防使用外形相似度较高的名称。
例如,想区分模块某处的XYZControllerForEfficientHandlingOfStrings和另一组XYZControllerForEfficientStorageOfStirngs,会花太长时间了。

  • 做有意义的区分

以数字系列命名(a1,a2...)是依意命名的对立面,完全没有提供正确信息以及提供向导作者意图线索。
反面教材:
getActiveAccount()
getActiveAccounts()
getActiveAccountInfo()

  • 使用读得出来的名称

  • 使用可搜索的名称

  • 避免使用编码

1、成员前缀
不必用m_前缀来标明成员变量。应当把类和函数做得足够小,以消除对成员前缀的需要。
2、接口与实现
取消对接口的标识I,比如IShapeFactory改为ShapeFactory。
对实现进行标识,比如ShapeFactoryImpl、CShapeFactory。

  • 避免思维映射

不应当让读者在脑中把你的名称翻译成为他们所熟知的名称,这种问题经常出现在选择是使用问题领域属于还是解决方案领域的术语时。

  • 类名

  • 方法名

  • 别抖机灵

  • 每个概念对应一个词

例如在Android开发,Presenter中进行网络请求,请求方法一般叫requestXXX();那么都固定叫requestXXX(),就不要再搞一些getXXX(),acquireXXX()... 每个概念对应一个词。

  • 别用双关语

避免将同一单词用于不同目的。比如add();

  • 结合涉及问题的领域的名称

反例:firstName、lastName、street.....
正常:addFirstName、addrLastName、addrState...

  • 不要添加没用的语境

第三章 函数

  • 短小

我们常说函数不该长于1屏幕。但是具体要多小呢,不要有100行那么多,20行封顶最好。
1、代码块与缩进
if、else、while语句等,其中代码块应该只占一行,该行大抵应该是一个函数的调用语句。这样不但能保持短小,而且,因为块内调用函数拥有较具说明性的名称。

  • 只做一件事(类似设计模式中的单一职责)

函数应该做一件事。做好这件事。只做这一件事。
如何判断一个函数是否只做了一件事呢?也就是说看一看,函数只是做了该函数名下同一抽象层上的步骤,则函数还是只做了一件事。

  • 每个函数一个抽象层级

  • Switch/if...else...

Switch天生要做很多的事情,只写出一件事的Switch语句也很难。不过有的时候我们可以使用工厂模式,利用多态性来完成使用switch创建对象的过程,将switch对象的创建,隐藏在某个继承关系中。有的时候switch违反了开闭与单一职责原则,所以我们也要就事论事。

  • 使用具有描述性的名称

Ward原则:“如果每个例程都让你感到深合己意,那么就是整洁代码。”要遵守这一原则,在于为只做一件事的小函数起个好名字。函数越短小、功能越集中、就越便于起个好名字。
别害怕长名称。

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