为啥有这一篇 ?
-
发现关注技术本身,关注实现,关注优化,关注性能,关注复用,关注成本很多,但关注代码怎么写?写成什么样比较好?很少
-
真的是程序员和代码有一个能跑就行吗?
先说不好的样子
1、 重复的代码
当你要读一个数据,发现两个地方有,不知道该选择哪个。当你要实现一个功能,发现两个 rpc 接口、两个函数能做到,你不知道选哪一个
2、一个功能实现非常长 写超过80行的函数,下次再添加或者测试非常困难,一梭子干到底 不合理
3、代码执行顺序混乱 走逻辑时 不断更替,一定要关注代码 走去了哪里
好的设计
1、每一部分 独立分开
2、拼凑结合 组件化思想 多个组件 组合形成 一个页面功能
3、能少写就少写 能不写就不写
删除一行代码,给我带来的成就感要比添加一行要大 —— C 语言之父 Ken Thompson
4、设计 透明性
始终做到,理解自己调用的函数/复用的代码大概是怎么实现的 关键位置写备注 比如下面这个
5、命名规范 语义化
- 比如 获取信息 getXXX 设置 setXXX 更改格式 formatXXX
6、错误 有反馈 且不阻塞页面 正确 则保持沉默
- 非常常用 try{}catch(e){... loggly(xxxxx)} 捕获错误之后 发到监控 不阻塞页面
7、代码嵌套层次不能超过 4 层 超过4层没人愿意看的
8、一个文件 最好不要超过800行,提交 review 不要超过300行
9、一个函数 最好不要超过 80行
- 本节完 ~ 后续会出一个更加详细的版本