如何提升自己的代码质量?
写代码谁都会,但写出高质量的代码不容易。今天分享一下我的经验。
什么是高质量代码
高质量代码的特点:
- 能正常运行(这是最基本的)
- 别人能看懂
- 容易修改和扩展
- 性能可接受
很多新手写的代码,能跑,但只有自己能看懂,甚至过几天自己也看不懂了。
怎么提升代码质量
1. 命名要规范
变量名、方法名、类名都要有意义。
不要用a、b、c、temp这种名字,要用userName、orderList、calculateTotalPrice这种能看出含义的名字。
2. 方法不要太长
一个方法几百行,谁看了都头疼。
如果一个方法太长,拆成几个小方法。每个方法只做一件事。
3. 写注释
关键的逻辑要写注释。不是每行都写,而是复杂的、容易误解的地方写。
但更好的做法是:写出不需要注释就能看懂的代码。
4. 遵循代码规范
每种语言都有约定俗成的代码规范。比如Java的驼峰命名、缩进用4个空格等。
照着规范写,别人看起来会舒服很多。
5. 多看别人的代码
看优秀的开源项目,学习别人是怎么写的。
看多了,自然知道什么是好代码。
6. Code Review
如果有条件,让别人review你的代码。别人的视角能发现你自己发现不了的问题。
我的经历
刚开始工作的时候,我的代码经常被leader吐槽:
- 命名太随意
- 方法太长
- 没有注释
后来被喷多了,慢慢改过来了。
现在回头看以前写的代码,确实挺烂的。但这是每个程序员都会经历的过程。
推荐阅读
- 《代码整洁之道》:讲怎么写干净代码的经典书
- 《重构》:讲怎么改进已有代码的经典书
这两本书我都看过,确实有帮助。但更重要的是在实践中慢慢提升。
最后
代码质量是慢慢提升的,不是一下子就能写好的。
刚开始写代码烂很正常,不用太焦虑。多写多看多思考,慢慢就好了。
