我这几天看到了一些如何写出让同事无法维护的代码,但如何写出让同事好维护的代码就十分困难了,毕竟每个人写代码的习惯都不同。因此,通过查找资料我想向大家推荐几条建议。
《clean code》指出,要想写出好的代码,首先得知道什么是肮脏代码、什么是整洁代码;然后通过大量的刻意练习,才能真正写出整洁的代码。
而什么又是整洁的代码呢?书中给出了专家们的总结:
Bjarne Stroustrup:优雅且高效;直截了当;减少依赖;只做好一件事
Grady booch:简单直接
Dave thomas:可读,可维护,单元测试
Ron Jeffries:不要重复、单一职责,表达力(Expressiveness)
因此,在写代码的时候需要建立一个好的变量名,一个好的变量名可以一眼就让人知道这是个什么东西,是干什么的。如果实在无法用代码自身表达变量的意思,那就需要写注释了,注释在书中也给出了要求:
1.法务信息
2.对意图的注释,为什么要这么做
3.警示
4.TODO注释
5.放大看似不合理之物的重要性
对于函数,参数越多,输入情况越多,需要的测试用例越多,越容易出问题。所以,对函数进行细分,可以更有效的进行复用。
最后就是测试了,测试用例一直是很难的一部分,而其的要求如下:
1.没有测试之前不要写任何功能代码
2.只编写恰好能够体现一个失败情况的测试代码
3.只编写恰好能通过测试的功能代码
测试的FIRST准则:
快速(Fast)测试应该够快,尽量自动化。
独立(Independent) 测试应该应该独立。不要相互依赖。
可重复(Repeatable) 测试应该在任何环境上都能重复通过。
自我验证(Self-Validating) 测试应该有bool输出。不要通过查看日志这种低效率方式来判断测试是否通过。
及时(Timely) 测试应该及时编写,在其对应的生产代码之前编写。
当然还有就是,在工作开始之前,和同事进行一些沟通也是十分有效的方法。
这只是萌新的一些看法,希望大佬们多多担待。
如何写出方便同事的代码
最新推荐文章于 2022-10-24 10:02:59 发布