C语言编程规范.docVIP

C语言编程规范

头文件编码规范

1.禁止头文件循环依赖。

2..c/.h文件不要包含用不到的头文件。

3.禁止在头文件中定义变量。

4.同一产品统一包含头文件排列方式。（如功能块排序、文件名升序、稳定度排序。）

5.只能通过包含头文件的方式使用其他.c提供的接口，禁止在.c中通过extern的方式使用外部函数接口、变量。

函数编写规范

1.一个函数仅完成一件功能。

2.重复代码应该尽可能提炼成函数。

3.为简单功能编写函数

4.函数的返回值要清楚、明了，让使用者不容易忽视错误情况。

5.避免函数过长，新增函数不超过100行（非空非注释行）。

6.避免函数的代码块嵌套过深，新增函数的代码块嵌套不超过4层。

7.可重入函数应避免使用全局变量和禁止使用static变量。

8.设计高扇入，合理扇出（小于7）的函数。

9.废弃代码（没有被调用的函数和变量)要及时注释（有助于更好理解程序）。

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

11.函数不变参数使用const。

12.函数应避免使用全局变量、静态局部变量和I/O操作，不可避免的地方应集中使用。

13.函数的参数个数不超过5个。

14.减少或禁止函数本身或函数间的递归调用

标识符命名与定义

3.1通用命名规则

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

2.除了常见的通用缩写以外，不使用单词缩写，不得使用汉语拼音。

示例：

argument可缩写为argbuffer可缩写为buffclock可缩写为clk

command可缩写为cmdcompare可缩写为cmpconfiguration可缩写为cfg

device可缩写为deverror可缩写为errhexadecimal可缩写为hex

increment可缩写为incinitialize可缩写为initmaximum可缩写为max

message可缩写为msgminimum可缩写为minparameter可缩写为para

previous可缩写为prevregister可缩写为regsemaphore可缩写为sem

statistic可缩写为statsynchronize可缩写为synctemp可缩写为tmp

3.产品/项目组内部应保持统一的命名风格。（Unixlike和windowslike风格）

4.自己特有的命名风格，要自始至终保持一致，不可来回变化。

5.命名中若使用特殊约定或缩写，则要有注释说明。

6.用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。

示例：

add/removebegin/endcreate/destroy

insert/deletefirst/lastget/release

increment/decrementput/getadd/delete

lock/unlockopen/closemin/max

old/newstart/stopnext/previous

source/targetshow/hidesend/receive

source/destinationcopy/pasteup/down

7.尽量避免名字中出现数字编号，除非逻辑上的确需要编号。

8.平台/驱动等适配代码的标识符命名风格保持和平台/驱动一致。

9.重构/修改部分代码时，应保持和原有代码的