整洁代码:不是写出来的,而是读出来的
几乎每个软件工程师都听说过“整洁代码”这个词,也知道代码的整洁程度代表着一个软件工程师的专业素养,因此很多人埋头钻研怎么才能写出整洁代码。在我看来,整洁代码不是写出来的,而是读出来的。换句话说,不是写的人说自己的代码整洁就算整洁,而是读的人觉得整洁才算整洁。
我们每个人写的代码都要被别人阅读,而别人阅读你的代码往往是带着问题来的。判断你的代码整不整洁,一个最基本的标准是,读代码的人根本不用问你,只要上下读几行或者看看注释,顺着逻辑就能知道这些代码是什么意思,以及他要用的话该怎么用。
因此,整洁代码的核心在于,你心里要装着将来要阅读这段代码的人,从方便阅读的角度去布局、设计。具体怎么做呢?给你两个建议:第一是遵守公司的编码规范,这一点前文已经说过;第二是写出干净的接口。什么是干净的接口?假设你写了一段代码,别人联调的时候不需要问你就知道接口该怎么用;一旦遇到性能问题,或者要在下个版本添加功能,别人很自然地就知道该在哪里加这个功能—这样的接口就是干净的接口。
我入行最初两年,桑杰·格玛瓦特(Sanjay Ghemawat)是我的团队领导,他在接口设计上有一套习惯,我觉得很受用。具体来说,他在评审代码时,会要求我们给接口加注释,在注释里给出一些基本的使用例子,告诉别人这个接口怎么用,比如怎么用这个接口写出一个小程序。而在一些高并发、多线程的程序里,他会要求我们注释清楚,某个接口是否允许高并发,它的线程控制是怎么样的,内存管理是什么样的,等等。这对读代码以及使用代码的人就非常友好。
那作为写代码的人,我们就要考虑得尽量全面一些,最好是不仅考虑到当下可能会遇到哪些问题,还能预想到明年会有什么需求,并考虑到当这个需求来的时候,可以在哪个地方改,给后来的人一个大致的方向,为将来的可扩展性预留空间。
总之,整洁代码一定是方便使用者的。如果使用者想到的问题你预先都想到了,并且在注释或文档里全部讲清楚了,这样的代码不会差。
在线咨询~
【免责声明】
1、个别文章内容来源于网络善意转载,版权归原作者所有,如侵权,请联系删除;
2、所有图片来源于网络,版权归原作者所有。如有侵权问题请告知,我们会立即处理。

