代码规范

发表于 | 分类于

代码风格

代码简洁 VS 代码易读

1
2
3
4
5
6
7
if (variable != null) {
   return variable.getSomething();
}
return null;


return x >= 90 ? "A" : x >= 80 ? "B" : x >= 70 ? "C" : x >= 60 ? "D" : "E";

坚持使用最直观的编码方式，而不是追求代码简短，真的可以避免很多不必要的错误。golang 不支持条件运算符

好代码 VS 坏代码

好代码

  • 容易理解(if 和条件运算符?)
  • 没有安全问题(*指针 并发 map)
  • 有充分的注释(关键地方有注释)
  • 命名规范(驼峰和下划线)
  • 有充分的测试(先测试再上线)

坏代码

  • 难以阅读（函数太长太大）
  • 浪费计算机资源
  • 代码风格混乱
  • 没有测试

优秀程序员

硬指标

  • 优秀的编程技能
  • 解决问题能力
  • 认知和发现问题的能力

软指标

  • 为高效推进目标进程，作出合适的权衡和妥协
  • 团队协调能力
  • 时间管理能力

怎么写注释

  • Code Tells You How, Comments Tell You Why.
  • 参考 golang 源码
    • 核心方法注释【英文不好可以用中文】

异常处理

底层 IO 的错误，抛给上层处理，上层来处理各种错误

  • socketIO 【redis/mysql/kafka】
  • file

文档

  • 简介
  • 快速上手
  • 开发指南
  • 高级用法
  • 二次开发

高效工具

  • 思维导图
  • 时序图
  • 问题清单