美文网首页
代码整洁笔记

代码整洁笔记

作者: ysdyyy | 来源:发表于2019-06-26 09:20 被阅读0次

    代码千万条,清晰第一条,编码不规范,同事两行泪。
    本文为《代码整洁之道》读书笔记

    一: 函数
    1.1 短小
    1.2 只做一件事
    1.3 函数内代码当属于同一个抽象层级
    1.4 使用描述性的名称
    1.5 参数尽量少
    1.6 无副作用
    1.7 分离指令和询问(函数要么查询,要么更改)
    1.8 使用异常代替错误码
    1.9 抽离try/catch代码块
    1.10 别重复自己(重复可能是软件中一切邪恶的根源)
    1.11 结构化编程
    小结:函数自身当短小和专注,在整个项目集合中应当减少重复代码。函数编写首先是不出BUG,然后是具备良好可读性。

    二:注释
    2.1 最好的注释是消除注释,以命名来代替注释。
    2.2 及时删除陈旧的注释。
    小结:对外提供的借口,注释要写全,因为使用者没有义务去阅读开发者的实现细节;内部代码尽量在保持可读性的前提下减少注释。

    三:对象和数据结构
    3.1 对象和数据结构之间的二分原理:
    过程式代码便于在不改动现有数据结构的前提下增加新函数,面向对象代码便于在不改动既有函数的前提下增加新类
    小结:过程式代码和面向对象代码忽悠利弊。当我们希望灵活的添加新数据类型,当使用对象;当我们希望能灵活的添加新行为,当使用数据类型和过程

    四:错误处理
    4.1 使用异常而非返回码
    4.2 先写try catch finally语句
    4.3 使用不可控异常
    4.4 给出异常发生的环境说明
    4.5 依调用者需要定义异常类
    4.6 定义常规流程。将异常行为封装到特例对象中,减少调用方对异常行为的处理代码
    4.7 别返回null
    4.8 别传递null
    小结:错误处理让代码更强固

    相关文章

      网友评论

          本文标题:代码整洁笔记

          本文链接:https://www.haomeiwen.com/subject/bqlqcctx.html