从编程菜鸟一路走来,慢慢对编程习惯有了一个新的认识。因为曾经我写的代码的可读性令自己也感到哭啼皆非,搞得自己晕头转向。今天特意来分享一下自己的一些关于编程习惯的心得。
很多人以为代码一敲完,能得到预期的结果,就万事ok,其实不然。后面的程序调试、维护和升级是一个项目中很重要的一部分,这就要求我们必须规范编程习惯。
(1)模块化编程
试想一下,如果一个项目的所有功能都在一个main.c里面实现,这阅读的难度可想而知,初次接触这个项目的新手估计得花上好几天来搞定其中的逻辑功能关系吧!而且心里还一直骂着这个程序的开发者。模块化的目的就是为了降低程序的复杂度,使程序的设计、维护和调试都易于处理。
模块化编程要求我们活用.c和.h文件。我们该怎么做呢?例如要实现一个温湿度传感器读取数据的功能,我们可以在getData.c文件里面编写温湿度传感器读取数据的驱动函数,然后在getData.h文件里面声明该驱动函数和所需的外部变量等等,最后在main.c文件里面包含getData.h文件,就可以在main.c文件里面引用所需的温湿度传感器读取数据的驱动函数。getData.h文件实际上起到一个接口作用。同理,我们可以使一个子功能用一个.c和.h文件来实现,到最后在main.c文件中用#include包含所有子功能的.h文件,便可以有效组织起整个项目的架构,使其他人对整个功能需求一目了然。
(2)善用#define
修改程序烦不烦?很烦!尤其是数不清的数字和端口引脚(嵌入式)。那么此刻#define就派上用场了。我们经常把一些以后根据需要改动的数字用宏定义在表示:
#define RX_BUF_MAX_LEN 1024 //接收区缓冲字节最大长度
那么以后需要用到1024这个数字时,则使用RX_BUF_MAX_LEN:
char Data_RX_BUF [ RX_BUF_MAX_LEN ];//定义接收缓冲区
若以后接收区缓冲字节最大长度有改变,则直接修改1024,多方便啊!同理,对于一些端口引脚同样可以使用宏定义,以便以后更改引脚后,直接在宏定义里面改,免得在整个程序里面找这个引脚找得焦头烂额,还担心有遗漏!
(3)命名规则很重要
这个太重要了!如果一个程序没有任何注释,读者还能看懂,说明程序编写者充分发扬了
程序自注释的特点,这样的程序简直赏心悦目!当中就涉及到命名的重要性。实际上一个团队必须要有自己的命名规则,否则最终出炉的程序的易维护性和易读性会大幅下降。
敲代码毕竟是外国人发明的东西,因此首先要强调的是变量名或函数名都必须要用英文单词或者其有效的缩写!如果你要使用要义不明的英文字母,对不起,你的代码就已经打折扣了。其次怎么写也很重要,当前使用非常广泛的命名规则是驼峰命名法,也即当变量名或函数名是由一个或多个单词连接起来时,第一个单词以小写开头,往后每个单词都以大写开头,比如getWeight();人家一看这个函数名就知道它的作用是取得重量值。
其实还有很多良好的编程习惯,这里就不一一列举。总之,良好的编程习惯能节省你很多宝贵的时间!