本文共 419 字,大约阅读时间需要 1 分钟。
最近大概读了一遍代码整洁之道,感觉自己目前能想到的需要改进的地方包括:
1. 注释
在写代码的时候很喜欢写一堆注释出来,主要还是为了理清楚思路,然后便于后续再看的时候来理解当时为什么这么做。
但是通过更合理的函数命名可以解决。同时过期的注释也需要及时删掉。避免影响后续开发的思路。目前项目中有部分未删掉感觉是之前的同事留下来的,会有点不敢动。
2. 函数
函数的命名,应该直接可以表明该函数的权责
函数的输入参数也需要注意,过多或者参数类型相同时,可能会导致问题。感觉同样类型的参数,很容易会写错位置。
3. 格式
之前没有明确了解过格式方面的规则,看过书之后,才注意垂直格式和横向格式,也是自己需要调整的地方。
比如:封包声明、导入声明和函数之间的空白行。多个函数之间的顺序(某个函数调用了另外一个,应该放到一起,调用者应该在被调用者上面)。概念相关的代码也应该放在一起,相关性越强,距离越近。
后续有时间在读一遍,希望有更多的体会吧。
转载地址:http://hoyai.baihongyu.com/