今天在考虑一个项目究竟为什么好做、为什么不好做的原因时,得到一些感悟。
在做一个满是前端js代码的项目时,感觉为了修改一个小功能,却要花费很大的代价,时间都花在读懂代码上。
“同一个文件里面代码多,且一个小函数里面做的事情太多,并且没有注释它到底是为了什么而做这一步,短短的6行代码,都是为别处的函数做伏笔,没法判断每一行的目标。”
变量的来源不好追踪、变量定义后的用途不明,变量命名没有意义,所有的代码很难理解。
解决办法是:
1、对于某块功能,要有对应的流程步骤说明文档
2、相关函数要有说明文档
3、变量命名要有意义
4、代码做的事情可以引入对应的对象来统一管理,以便更好理解它的行为的意义和进行归类
5、把每一行代码当成一类问题去考虑,而不只是为了解决当前这一功能。