在公司这么久了,还没有好好学习编码规范,真的很土啊,现在整理一下公司的命名规则:
命名规范
下面的命名规范仅供参考:
A 变量名用大小写间隔单词,不使用下划线,且首字母大写,例如:cfgChn(config Channel)
B 局部变量名首字母可以小写,也可全小写,且建议小写,例如:tmp
C 涉及到NDT上定义的变量名首字母必须小写(和NDT上的定义保持一致)
D 所有类的成员变量必须加上m_前缀(结构的成员变量不用),例如:m_Time
E 结构体成员变量建议使用小写开头,大小写混排方式。
F 所有全局变量必须加上g前缀,例如:g_Time.
G所有静态变量必须加上s_前缀,例如:s_time
H变量名除了指针和数组必须加上类型前缀名(指针加上p前缀,数组加上a前缀),
其他类型前缀名可加可不加,例如:m_pTime (指针型变量),bPrtEn(布尔型变量)
I 函数名用大小写间隔单词,不使用下划线,且首字母大写,例如:GetSelr()
注释规范
注释方式采用java风格的注释。
注释主要写在头文件中,对于继承而来的函数,无需在写一遍注释(除非与原来的函数注释不同。)
编码风格
不作过多限制,但程序代码尽可能整理的整齐,方便阅读。
1) 系统头文件使用#include <xxxx.h>方式包含。
2) 工程头文件使用# include "xxxx.h"方式包含。
3)包含的文件的路径一律使用unix的路径风格。“/”
4)不允许出现绝对路径。
5)所有文件的最后一行必须是空行。
6)注意for scope的问题。
操作系统相关性处理
· 不要包含操作系统相关的头文件(c的标准库除外)
· 必须处理操作系统相关问题时,使用宏定义,并且一定要在发现不支持的操作系统时给出错误