摘录自代码规范:
头文件 :
1)头文件中适合防止接口声明,不适合放置实现(放置函数声明,宏定义,类型定义等)
2)文件内部使用的函数,声明等不应该防止在头文件中,对外可见
3)变量定义不要放在头文件中
4)少使用全局变量,要使用尽量对其做详细说明
5)头文件的只能最好单一,减少头文件之间的重复包含
6)每个c文件对应一个头文件,将对外接口声明在头文件中
7)不对外的函数和变量可适当的加上static关键字来确保其稳定性
8)c/h文件中尽量减少不用的头文件,可以减少编译时间
函数 :
1)一个函数仅完成一件事情
2)重复代码尽可能提炼成为函数
3)避免函数过长,避免函数过长,避免函数过长
4)避免函数参数过多,避免函数参数过多,避免函数参数过多
5)废弃代码及时清除
标识符和定义:
使用有意义的名称,长一点也无所谓,这样代码本身就是注释