在学校时,老师经常教导我们软件开发要按照一定的阶段,代码一定要写规范。大家都记得,但没经历过,并没放在心上,直到最近我才意识到代码规范的重要性。公司有同事要离职了,我接手他的工作,首先就要先熟悉他的代码结构和实现等的,拿过来一看才知道这真不是件容易的事。洋洋洒洒上万行代码,有些多余的也没删,有些消息映射好几个,没必要啊,注释也有,都是些函数中的细节,起码文件也该有个吧。所以,如果我们写代码时尽量遵循一定的规范,为了以后自己看,也为了别人能看懂,承训总是要维护的。我大致总结一些,以后尽量在变成种做到吧。
1.一定要有注释。每个头文件、实现文件要有,重要的函数要有,一些变量也要有,在文件注释中还可以协商与其他文件的关系,便于从整体上理解程序。
2.命名要统一。很多变化曾书籍也都提到,常用的是匈牙利命名法,其实每个人的命名规则不一样,但一个软件中要统一,比如整型加前缀i,类变量加前缀m_,类名加C,等等,这样看起来更舒服些。当然还包括每个文件的命名。
3.代码要精简。有时我们建立了一个文件,后来不用了,在最后整理的时候要删除它,没用了留着干嘛呢,还有函数、变量,多余就删了。
4.注意代码复用。有些代码可能会用到几次,那就写个函数,每次用时调用那个函数,不要每次复制相似的代码。
5.合理组织文件。一些基本功能的常用调用的文件放在一个文件夹下,也可以打包成库,这样相关的文件放在同一个包下,有点像java的包了,呵呵。
6.最好有开发文档。主要在软件开发完成时把程序的总体框架写下来,还有用到的技术,便于后面维护的人更快理解它。