代码整洁之道读书笔记

为什么要保持代码整洁/h2>

高大上

  1. 软件质量,不但依赖于架构及项目管理,而且与代码质量紧密相关;而代码质量与其整洁度成正比。
    软件质量 代码质量 整洁度。
  2. 如果将软件比作一座宏大的建筑的话,那么宏大建筑中最细小的部分,比如关不紧的门、有点儿没铺平的地板,甚至是凌乱的桌面,都会将整个大局的魅力毁灭殆尽。这就是整洁代码之所系。

贴合实际

  1. 代码混乱的代价:随着混乱的增加,团队生产力持续下降,趋向于零。(混乱增加,生产力下降 -> 管理层增加人手,期望提升生产力 -> 新人不熟悉系统的设计,制造更多的混乱)。
    代码整洁之道读书笔记

    第2章 有意义的命名

    1. 名副其实

    变量、函数或类的名称应该已经答复了所有的大问题。它该告诉你,它为什么会存在,它做什么事,应该怎么用。如果名称需要注释来补充,那就不算是名副其实。

    ? theList中是什么类型的东西br> ? theList零下标条目的意义是什么br> ? 值4的意义是什么br> ? 我怎么使用返回的列表/p>

    2. 做有意义的区分

    getActiveAccount();
    getActiveAccounts();
    getActiveAccountInfo();
    根本不知道调用哪个函数。

    3. 使用可搜索的名称

    找MAX_CLASSES_PER_SUTUDENT很容易,但想找数字7就麻烦了。

    4. 类名和对象名应该是名词或名词短语,方法名应该是动词或动词短语

    第3章 函数

    1. 短小

    函数的第一规则是要短小,第二条规则是还要更短小。(集团代码规约认为函数体行数应小于80行)

    搞懂整个函数了么概没有。有太多事发生,有太多不同层级的抽象,奇怪的字符串和函数调用,用标识来控制的if语句等,不一而足。
    不过,只做几个简单的方法抽离和重命名工作,加上一点点重构,就能在9行代码之内搞定。

    还可以更加短小:

    2. 函数应该做一件事。做好这件事。只做这一件事

    3. 使用描述性的名称

    别害怕长名称,长而具有描述性的名称,要比短而令人费解的名称好。

    4. 函数参数

    ? 最理想的参数数量是零,其次是一,再次是二,应尽量避免三参数函数。参数越多越难懂,调用时越容易出错。

    来源:fitzzhang

    声明:本站部分文章及图片转载于互联网,内容版权归原作者所有,如本站任何资料有侵权请您尽早请联系jinwei@zod.com.cn进行处理,非常感谢!

上一篇 2020年5月21日
下一篇 2020年5月21日

相关推荐