前端规范

• Clean Code JS
  • 简介
    • 原则&指南
    • 目的
      • 生产可读的、可重用的、可重构的软件指南
  • 变量
    • 使用有意义并且可读的变量名称
    • 为相同类型的变量使用相同的词汇
    • 使用可搜索的名称
    • 使用解释性的变量
    • 避免心理映射
    • 不添加不必要的上下文
    • 使用默认变量替代短路运算或条件
  • 函数
    • 函数参数 (两个以下最理想)
    • 函数应当只做一件事情
    • 函数名称应该说明它要做什么
    • 函数应该只有一个抽象级别
    • 移除冗余代码
    • 使用 Object.assign 设置默认对象
    • 不要使用标记位做为函数参数
    • 避免副作用
    • 不要写入全局函数
    • 函数式编程优于指令式编程
    • 封装条件语句
    • 避免负面条件
    • 避免条件语句
    • 避免类型检查 (part 1)
    • 避免类型检查 (part 2)
    • 不要过度优化
    • 移除僵尸代码
  • 对象和数据结构
    • 使用 getters 和 setters
    • 让对象拥有私有成员
  • 类
    • ES2015/ES6 类优先与 ES5 纯函数
    • 使用方法链
    • 组合优先于继承
  • SOLID
    • 单一职责原则 (SRP)
    • 开闭原则 (OCP)
    • 里氏代换原则 (LSP)
    • 接口隔离原则 (ISP)
    • 依赖反转原则 (DIP)
  • 测试
    • 一个测试一个概念
  • 并发
    • 使用 Promises, 不要使用回调
    • Async/Await 比 Promises 更加简洁
  • 错误处理
    • 不要忽略捕捉到的错误
    • 不要忽略被拒绝的 promise
  • 格式化
    • 使用一致的大小写
    • 函数的调用方式与被调用方应该靠近
  • 注释
    • 仅仅对包含复杂业务逻辑的东西进行注释
    • 不要在代码库中保存注释掉的代码
    • 不要有日志式的注释
    • 避免占位符