C语言编程规范.doc

《C语言编程规范.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、编码规范1.头文件编码规范32.函数编写规范33.标识符命名与定义33.1通用命名规则33.2变量命名规则43.3函数命名规则43.4宏的命名规则44.变量45.宏、常量56.质量保证57.程序效率68.注释69.排版与格式710.表达式811.代码编辑、编译812.安全性813.可读性814.可测性815.单元测试916.可移植性91.头文件编码规范1.禁止头文件循环依赖。2..c/.h文件不要包含用不到的头文件。3.禁止在头文件中定义变量。4.同一产品统一包含头文件排列方式。（如功能块排序、文件名升序、稳定度排序。）5.

2、只能通过包含头文件的方式使用其他.c提供的接口，禁止在.c中通过extern的方式使用外部函数接口、变量。1.函数编写规范1.一个函数仅完成一件功能。2.重复代码应该尽可能提炼成函数。3.为简单功能编写函数4.函数的返回值要清楚、明了，让使用者不容易忽视错误情况。5.避免函数过长，新增函数不超过100行（非空非注释行）。6.避免函数的代码块嵌套过深，新增函数的代码块嵌套不超过4层。7.可重入函数应避免使用全局变量和禁止使用static变量。8.设计高扇入，合理扇出（小于7）的函数。9.废弃代码（没有被调用的函数和变量)要及时

3、注释（有助于更好理解程序）。10.对所调用函数的错误返回码要仔细、全面地处理。11.函数不变参数使用const。12.函数应避免使用全局变量、静态局部变量和I/O操作，不可避免的地方应集中使用。13.函数的参数个数不超过5个。14.减少或禁止函数本身或函数间的递归调用2.标识符命名与定义3.1通用命名规则1.标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写，避免使人产生误解。2.除了常见的通用缩写以外，不使用单词缩写，不得使用汉语拼音。示例：argument可缩写为argbuffer可缩写为b

4、uffclock可缩写为clkcommand可缩写为cmdcompare可缩写为cmpconfiguration可缩写为cfgdevice可缩写为deverror可缩写为errhexadecimal可缩写为hexincrement可缩写为incinitialize可缩写为initmaximum可缩写为maxmessage可缩写为msgminimum可缩写为minparameter可缩写为paraprevious可缩写为prevregister可缩写为regsemaphore可缩写为semstatistic可缩写为statsy

5、nchronize可缩写为synctemp可缩写为tmp3.产品/项目组内部应保持统一的命名风格。（Unixlike和windowslike风格）4.自己特有的命名风格，要自始至终保持一致，不可来回变化。5.命名中若使用特殊约定或缩写，则要有注释说明。6.用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。示例：add/removebegin/endcreate/destroyinsert/deletefirst/lastget/releaseincrement/decrementput/getadd/deletelo

6、ck/unlockopen/closemin/maxold/newstart/stopnext/previoussource/targetshow/hidesend/receivesource/destinationcopy/pasteup/down7.尽量避免名字中出现数字编号，除非逻辑上的确需要编号。8.平台/驱动等适配代码的标识符命名风格保持和平台/驱动一致。9.重构/修改部分代码时，应保持和原有代码的命名风格一致。3.2变量命名规则1.全局变量应增加“g_”前缀。2.静态变量应增加“s_”前缀。3.禁止使用单字节命名

7、变量，但允许定义i、j、k作为局部循环变量。4.使用名词或者形容词＋名词方式命名变量。3.3函数命名规则1.函数命名应以函数要执行的动作命名，一般采用动词或者动词＋名词的结构2.函数指针除了前缀，其他按照函数的命名规则命名。3.4宏的命名规则1.对于数值或者字符串等等常量的定义，建议采用全大写字母，单词之间加下划线‘_’的方式命名（枚举同样建议使用此方式定义）。示例：#definePI_ROUNDED3.142.除了头文件或编译开关等特殊标识定义，宏定义不能使用下划线‘_’开头和结尾。1.变量1.一个变量只有一个功能，不能把

8、一个变量用作多种用途。2.结构功能单一，不要设计面面俱到的数据结构。3.不用或者少用全局变量。4.防止局部变量与全局变量同名。5.严禁使用未经初始化的变量作为右值。6.构造仅有一个模块或函数可以修改、创建，而其余有关模块或函数只访问的全局变量，防止多个不同模块或函数都可以修改、创建同一全局