一些编程规范注意事项

1.排版

1.注意缩进；

2.相对独立程序块变量之间加空行；

3.较长语句要分行，一般有在运算符处分行，运算符为下一行起始，也要注意缩进，多个运算符就在低优先度位置分行，在判断循环语句和函数参数中也是如此；

4.一行一句；

5.if等语句占一行，且必须配合花括号{}使用；

6.缩进用空格不同tab；

7.每个花括号独占一行并两两对其，且要与花括号所属语句的第一个字母对其；

8.多个变量即使用逗号隔开，逗号后也要加空格；

9.单目运算符后不用加空格，其他常见运算符前后都要加空格

10.if、while、for、switch与其括号中间应加空格

#pragma warn -rvl // 关闭警告

#pragma warn +rvl // 打开警告

2.注释

1.说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应 进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的 关系、修改日志等，头文件的注释中还应有函数功能简要说明。

2.源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、 主要函数及其功能、修改日志等。

3.：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用 关系（函数、表）等。

4.避免在代码中间插入注释，稍微细节一些的代码都需要写明注释确定功能；

5.在程序块结束的位置加注释，也就是花括号后面的位置添加；

3.标识符命名

1.：标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的 缩写，避免使人产生误解。

2.对于变量命名，禁止取单个字符（如i、j、k...），建议除了要有具体含义外，还能 表明其变量类型、数据类型等，但i、j、k作局部循环变量是允许的；

3.可以有你自己的风格，但必须要延续不能乱改，并且在程序开头写好注释来告知他人意义；

4.命名时清晰明了，尽量都使用常见的与其意思相对应的英文，不要出现莫名其妙的数字；

4.可读性

1.注意运算符的优先级，并用括号明确表达式的操作顺序便于理解，避免使用默认优先级；

2.避免使用不易理解的数字，用有意义的标识来替代。涉及物理状态或者含有物理意义的 常量，不应直接使用数字，必须用有意义的枚举或宏来代替；

3.不要炫技写高难度代码，除非很有必要，不然很降低可读性；

5.变量和结构

1.设计结构时功能结构要单一，不要一个结构实现多个功能，并且每个结构里的功能都是有关联的，弱关联的功能分为一个新的结构里去使用；

2.结构中元素的个数应适中。若结构中元素个数过多可考虑依据某种原则把元素组成不同 的子结构，以减少原结构中元素的个数

3.仔细设计结构中元素的布局与排列顺序，使结构容易理解、节省占用空间，并减少引起 误用现象

4.当声明用于分布式环境或不同CPU间通信环境的数据结构时，必须考虑机器的字节顺 序、使用的位域及字节对齐等问题

6.函数和过程

1：对所调用函数的错误返回码要仔细、全面地处理。

2：明确函数功能，精确（而不是近似）地实现函数设计。

3：编写可重入函数时，应注意局部变量的使用（如编写C/C++语言的可重入函数时，应使 用auto即缺省态局部变量或寄存器变量）。 说明：编写 C/C++语言的可重入函数时，不应使用 static 局部变量，否则必须经过特殊 处理，才能使函数具有可重入性。

4：编写可重入函数时，若使用全局变量，则应通过关中断、信号量（即P、V操作）等手段 对其加以保护。

5：在同一项目组应明确规定对接口函数参数的合法性检查应由函数的调用者负责还是由接 口函数本身负责，缺省是由函数调用者负责。

6.防止在函数中直接将参数作为工作变量；

7.一个函数就完成一个功能，简单的函数可以用宏定义替换可以提升效率；

8.函数命名时应清晰明了的表达出实现的功能，并且需要检查参数的有效性；

9.少用递归