有一类程序员,他们的代码写的非常"聪明",但不易读懂。还有一种程序员,他们的代码写得特别好懂。应该尽量的向第二种程序员学习,写出易读易懂代码。因为代码会被维护者读很多很多次。
怎样才能写出易读的代码? 首先,代码要能清晰地表达意图。其次,代码体不宜过大,一般函数不应超过四十行,类体不超过二百行。类/函数/变量的命名尤其重要,要能洽当地融入上下文中,整个代码读起来相当通顺自然。
一般情况下,不应该用注释来解释代码。代码应该是自我可解释的。使用注释有两个例外:一是接口文档使用,二是极少数非常专业的算法解释。不用注释,可以强迫程序员写出意图明晰的代码。