我们自己写代码的时候,是否考虑到如何让代码容易于阅读和维护呢?
在代码复审时,有自我复审,同伴复审和团队复审,怎么让自己的代码更容易让别人阅读和维护是一件很重要的事。我阅读了这样一篇文章《微软资深软件工程师:阅读代码真的很难》,作者:Eric Lippert。
他提到:在编写代码时,尽量去做的事,目的就是使其他人能轻松阅读:
㈠,使代码遵从工具
①像"i"这样的变量名不好 ②避免使用是其他名字的前缀的名字 ③tramp data应使用相同的名字 ④别用宏重命名东西 ⑤不要使用shadowing,它会引起很多问题
㈡,坚持使用一种命名模式
㈢,使用断言来记录先决条件和后置条件
㈣,别缩写英文单词
㈤,C语言标准运行时库的设计不是很优秀,别效仿
㈥,别写聪明的代码
㈦,理解编程语言特性的设计初衷,使用这些特性去做他们适合的工作,而不是他们能做到的工作
㈧,按功能单元划分源码树,而不是按组织结构
作者也提供了阅读别人代码的方法:通常从代码头部开始,知道类是如何实现的,如何扩展的,它的作用,如何嵌入整个代码中的。然后再看别人的代码,就行修改。