ZBSK0K305(V1.0)C语言开发规范.doc

上海宝信软件股份有限公司
解决方案事业本部作业指导书
文件编号:CBSK0K305 版本号: 保密级别:内部公开签发:黄颖雷
C语言开发规范
:本文适用于解决方案事业本部使用C语言开发的所有项目。
:无。
文件修改变更记录
序号
更改原因
修改后
版本号
修改人
修改日期
主要更改内容
新建

强徐刚

新建
拟稿:强徐刚日期:.
审核:陈宝福日期:.
【正文内容见下页】
C语言开发规范
目录
1 排版 6
程序块要使用缩进风格编写 6
相对独立的程序块之间、变量说明之后需要加空行 6
每一行有且仅有不超过一条语句,不允许把多个语句写在一行 6
每一行的字符长度不超过120个,超过的必须分行排列 6
if、for、do、while、case、switch、default等语句必须单独占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{} 6
程序块的分界符需要单独占一行(如C/C++语言的大括号‘{’和‘}’),并且位于同一列,同时与引用它们的语句左对齐 6
同一个级别的语句行应该左对齐 6
关键字之后需要留空格。 6
函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别。 6
左括号向后紧跟, 右括号、逗号、分号向前紧跟,紧跟处不留空格。逗号之后要留空格。如果分号不是一行的结束符号,其后要留空格。 6
赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=”、“+=”“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格。 7
一元操作符如“!”、“~”、“++”、“--”、“&”(地址运算符)等前后不加空格,如“[]”、“.”、“->”这类操作符前后也不加空格。 7
2 注释 7
在一个程序中,注释的行数将不少于总行数的 10% 7
边写代码边注释,修改代码的同时修改相应的注释,保证注释与代码保持一致 7
说明性文件(、.inc文件、.def文件、)头部应进行注释,并且每个函数的申明前也需要注释 7
每个程序的头部应该进行注释,范例如下: 7
程序内自定义函数需要进行注释,说明函数的作用或者功能,输入、输出参数、返回值等信息 8
对程序代码进行修改后,必须填写注释信息,并且标注修改人、修改时间、修改内容等信息 8
当需要对程序中的代码进行删除的时候,不能直接删除代码,而应该把不需要的代码通过注释间接删除。对于已经发布的程序,可以直接删除。 8
避免在一行代码或者表达式的中间插入注释 8
当代码较长的时候,特别是在多重嵌套时,应该在一些段落的结束处加注释 8
3 标识符命名 9
service程序的命名规范 10
函数程序的命名规范 10
命名中若使用特殊约定或缩写,需要注释说明 10
命名中不能出现仅仅依靠大小写区分的相似标识符 10
对于变量命名,禁止取单个字符(如i、j、k...),建议除了要有具体含义外,还能表明其变量类型、数据类型等,但i、j、k作局部循环变量是允许的 11
命名规范必须与所使用的系统风格保持一致,并在同一项目中统一,比如采用UNIX的全小写加下划线的风格或大小写混排的方式,不要使用大小写与下划线混排的方式,用作特殊标识如标识成员变量或全局变量的m_和g_,其后加上大小写混排的方式是允许的 11
用正确的反义词组命名具有互斥意义的变量或相反动作的函数等 11
除了编译开关/头文件等特殊应用,应避免使用_EXAMPLE_TEST_之类以下划线开始和结尾的定义。 12
避免使用不易理解的数字,用有意义的标识来替代。涉及物理状态或者含有物理意义的常量,不应直接使用数字,必须用有意义的枚举或宏来代替 12
在比较变量和数值常量的时候,建议把数值常量放在第一位 12
4 变量、结构 12
当给全局变量、结构体赋值的时候,防止赋予不合理的值或者越界现象发生 12
防止局部变量和公共变量同名 12
尽可能在定义变量的同时初始化变量 12
仔细设计结构中元素的布局与排列顺序,使结构容易理解、节省占用空间,并减少引起误用现象 12
结构的设计要尽量考虑向前兼容和以后的