代码整洁之道
文章平均质量分 74
l1024049542
这个作者很懒,什么都没留下…
展开
-
第二章 命名的意义
2.2 名副其实当发现更为合适的名称时,及时换掉旧名称;变量名称应当解释其为何存在,如何使用,当需要注释时,不能称为名副其实对于变量的命名,开头的单词小写,之后的单词首字母大写;当一段简洁的代码不能解释其具体功能时,问题是其模糊度出现问题,即上下文含义不能再代码中体现出来;2.3 避免误导名称中不要出现误导词,例如一些具有特定含义的缩写,或者计算机科学中特定的名称;(需要解释)不要使用原创 2017-11-30 14:08:03 · 330 阅读 · 0 评论 -
第三章 函数
3.1 短小函数第一规则短小第二规则短小if、else、while中的代码块语句应该只有一行;该行应该是一个函数调用语句,并且名称具有解释函数本身作用的功能;函数不应大到可以容纳嵌套结构,缩进层应该只有一层或者两层;3.2 只做一件事一件事是指在同一抽象层上的事情;原创 2017-12-03 15:25:31 · 250 阅读 · 0 评论 -
第四章 注释
第四章 注释1 注释不能美化的代码2 用代码来阐述3 好注释31 法律信息32 提供信息的注释33 对意图的解释34 阐释35 警示36 TODO注释37 放大4 坏注释41 喃喃自语42 多余的注释43 误导性注释44 循规式注释45 日志式注释46 废话式注释47 可怕的废话48 能用函数或变量时就别用注释49 位置标记410 括号后面的注释411 归属原创 2017-12-20 16:39:01 · 326 阅读 · 0 评论 -
第五章 格式
第五章 格式1 格式的目的2 垂直格式21 向报纸学习22 概念间垂直方向上的区隔23 垂直方向上的靠近24 垂直距离25 垂直顺序3 横向格式31 水平方向上的区隔与靠近32 水平对其33 缩进34 空范围4 团队规则第五章 格式5.1 格式的目的代码格式关乎沟通,而沟通是开发者的头等大事;代码的实现可能被修改,而代码格式会一直被继承下去;5.2 垂直格式5.2.原创 2017-12-24 16:27:55 · 258 阅读 · 0 评论 -
第六章 对象和数据结构
第六章 对象和数据结构1 数据抽象2 数据对象的反对称性3 德墨忒耳律The Law of Demeter31 火车失事32 混杂33 隐藏结构4 数据传输对象第六章 对象和数据结构变量设为私有(private)可以使外部不依赖于这些变量,并且可以变量的类型;6.1 数据抽象//此种数据结构清楚的表达了在笛卡尔坐标系下,可以单个操作,暴露了实现;即使变量私有,通过取值器和赋值器任原创 2017-12-26 20:19:09 · 1245 阅读 · 0 评论 -
第九章 单元测试
第九章 单元测试1 TDD三定律2 保持测试整洁3 整洁的测试31 面向特定领域的测试语言32 双重标准4 每个测试一个断言5 FIRST第九章 单元测试9.1 TDD三定律在编写不能通过的测试代码之前,不能编写生产代码(业务代码);即先写不能通过编译的测试代码,再编写业务代码;编写刚好无法通过的测试代码;即编写范围刚好的测试代码,无法通过是由于业务代码未编写;编写范围刚好的业原创 2018-01-03 20:15:07 · 277 阅读 · 0 评论 -
第七章 错误处理
第七章 错误处理1 使用异常而非返回码2 先写Try-Catch-Finally3 使用不可控异常4 给出异常发生时的环境说明5 依调用者需要定义异常类6 定义常规流程7 别返回null值8 别传递null值第七章 错误处理错误处理不应该搞乱代码逻辑7.1 使用异常而非返回码在以往的错误返回中,通常使用返回码(宏定义)、NULL等;在这样的操作往往需要调用者在调用后立即进行错原创 2017-12-29 20:54:41 · 233 阅读 · 0 评论 -
第八章 边界
第八章 边界1 使用第三方代码2 浏览和学习边界3 学习log4j4 学习性测试的的好处不只是免费5 使用尚不存在的代码6 整洁的边界第八章 边界8.1 使用第三方代码借口提供者和使用者之间存在天然的分歧:提供者希望借口具有普适性,而使用者希望满足特定的需求;这样的差异导致在使用第三方接口时在边界上出现问题//此方法将sensors暴露在外部,在函数间传递不安全Map senso原创 2017-12-30 16:45:24 · 256 阅读 · 0 评论 -
第十章 类
第十章 类1 类的组织2 类应该短小21 单一权责原则22 内聚23 保持内聚性就会得到许多短小的类3 为了修改而组织第十章 类10.1 类的组织类的组织应该从一组变量开始;首先是公有静态变量,之后私有静态变量,以及私有实体变量;很少会有公共实体变量;公共函数应该跟在变量之后;公共函数调用的私有工具函数紧随其后;封装尽可能保持变量原创 2018-01-05 20:40:36 · 231 阅读 · 0 评论