代码编写规范指南v3.0

Command cmd
Maximum Max
sychronize Sync
Compare
cmp
Message
Msg
Temp
Tmp
configuration cfg
Minimum Min
error
err
device
dev
Parameter Para
Previous
Prev
2
2.2 变量命名规则
（1）
2、标示符命名规则
2.1 通用命名规则
（1） 标示符要清晰，不要使用任意字符、缩写和汉语拼音，要使用完整单词。 示例：
int n；× //任意字符
int i; √//作为循环控制条件时允许
int nerror；× //任意缩写
int error_number √ //清晰
（2） 需要进行缩写的标示符，应遵循以下原则：①短单词去掉元音字母（a、e、i、
ห้องสมุดไป่ตู้
2.4 宏定义命名规则
（1） 对于字符串和数值等常量的定义，采用大写单词，单词之间以下划线‘_’分割， 除头文件和编译开关外，宏定义不能使用下划线‘_’作为开头和结尾。
1.3 引用规范
（1） 为防止头文件多次包含，头文件在使用时都必须有#define 保护代码，命名规范 FILENAME_H。示例如下： #ifndef _FILENAME_H //保证命名的唯一性 #define FILENAME_H #include filename.h #endif
（2） 引用外部函数和外部变量时，不得在本地头文件和源文件中以“extern”声明， 应当包含对方的头文件来声明。
1
1、头文件使用规则
1.1 依赖关系规则
（1） 尽量减少包含的头文件，未使用的头文件不得包含。 （2） 尽量避免在头文件中包含头文件。
1.2 包含内容
（1） 头文件中只包含声明，不包含实现。 （2） 头文件中只包含对外声明的变量、函数、宏定义等(C++的成员变量、成员函数
除外)，内部使用的变量、结构体、宏定义等不得包含。
代码开发规范指南
代码开发指南........................................................................................................................ 1 1、头文件使用规则....................................................................................................... 2 1.1 依赖关系规则.............................................................................................. 2 1.2 包含内容 ..................................................................................................... 2 1.3 引用规范 ..................................................................................................... 2 2、标示符命名规则....................................................................................................... 2 2.1 通用命名规则.................................................................................................. 2 2.2 变量命名规则.................................................................................................. 3 2.3 函数命名规则.................................................................................................. 3 2.4 宏定义命名规则.............................................................................................. 3 3、变量的使用规则....................................................................................................... 3 3.1 规则 1.............................................................................................................. 3 3.2 规则 2.............................................................................................................. 4 3.3 规则 3.............................................................................................................. 4 3.4 规则 4.............................................................................................................. 4 3.5 规则 5.............................................................................................................. 4 4、函数编写规则........................................................................................................... 5 4.1 规则 1.............................................................................................................. 5 4.2 规则 2.............................................................................................................. 5 4.3 规则 3.............................................................................................................. 5 4.4 规则 4.............................................................................................................. 5 5、宏的使用规则........................................................................................................... 6 5.1 规则 1 .............................................................................................................. 6 5.2 规则 2 .............................................................................................................. 6 5.3 规则 3 .............................................................................................................. 6 5.4 规则 4 .............................................................................................................. 7 6、程序排版与格式....................................................................................................... 7 6.1 规则 1.............................................................................................................. 7 6.2 规则 2.............................................................................................................. 7 6.3 规则 3.............................................................................................................. 7 6.4 规则 4.............................................................................................................. 8 6.5 规则 5.............................................................................................................. 8
变量前添加前缀和属性以区分变量类型。属性：全局变量 g_; 常量：c_; 类成 员变量：m_; 静态变量：s_。各类型前缀如表 2 所示。
表 2 类型前缀
指针
p
函数
fn
浮点型
f
双字
dw
字符
ch
整形
i
无效
v
字符串
s/str
字节
by
句柄
h
长整形
l
短整型
n
双精度浮点 d
字
w
实型
r
布尔
b
计数
c/cnt
无符号
u
2.3 函数命名规则
（1） （2）
函数命名一般采用动词+名词结构。例如：GetCurrentDirectory //获取当前路径 函数命名最好采用自注释模式。 命名规则建议与平台保持一致，Window 平台采用大小写混合模式，单词第一 个字母大写，如 AddChild；其 Unix 平台采用小写加下划线‘_’，如 add_child。
o、u）；②长单词取开头的几个字母。以下为常用单词缩写. 表 1 常用单词缩写
Argument Arg
hexadecimal hex
Register
Reg
Buffer
Buff
Increment inc
Semaphore Sem
Clock
Clk
init ia lize
init
Statistic
Stat