初识C语言编码规范.pdf

C语言编码规范

1-排版规则

程序应采用缩进风格编写，每层缩进使用一个制表位（TAB），类定义、方法都应顶格

书写；

源程序建议使用英文书写，尽量不含有中文。每行不超过80字符。对于较长的语句（80

字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，

划分出的新行要进行适当的缩进，使排版整齐，语句可读；循环、判断等语句中若有较长的

表达式或语句，则要进行适应的划分；

左花括号要另起一行，不能跟在上一行的行末；

一个变量定义占一行，一个语句占一行；

对独立的程序块之间、变量说明之后必须加空行；

在结构成员赋值等情况，等号对齐，最少留一个空格；

若函数或过程中的参数较长，则要进行适当的划分。

形参的排序风格：

最常使用的参数放在第一位；

输入参数列表应放在输出参数列表的左边；

将通用的参数放在特殊的参数的左边。

2-命名规范

应用程序的命名

“系统简称”+模块名称

子模块的命名

每个子模块的名字应该由描述模块功能的1-3以单词组成。每个单词的首字母应大写。在这

些单词中可以使用一些较通用的缩写。

变量的命名

变量的命名的基本原则是使得变量的含义能够从名字中直接理解。可以用多个英文单词拼写

而成，每个英文单词的首字母要大写，其中英文单词有缩写的可用缩写；变量的前缀表示该

变量的类型；对于作用域跨越10行以上的变量名称不能少于4个字符，除循环变量，累加

变量外不得使用I、j、k等名称的变量。变量分为取全局变量和局部变量，对于全局变量以

加前缀“g_”来区分。

使用有意义的英语单词,使用大小写分隔,每个单词的第一个字母为大写

考虑到习惯性和简洁性，对于按常规使用的局部变量允许采用极短的名字，如用n、i作为

循环变量，p、q作为指针等。另外，要注意的是：全局变量在程序中不要定义太多，能用

局部变量的就用局部变量。如果要使用相关的变量，建议采用类的方式或者结构的方式存放，

以减少具体变量的个数。

常量的命名

常量所有的字母均为大写。并且单词之间使用下划线”_”隔开。

函数/过程的命名

函数/过程名称应该尽量使用能够表达函数功能的英文名称，函数名称中应该禁止使用如同

function1,function2等含义不清的名称。单词间应该使用大小写分隔。全局函数/过程名称以

g_“”前缀开始。

接口命名

接口名称要以大写字母开头。如果接口包含多个单词，每个单词的首字母大写，其他字母小

写，如果，这些单词是缩略语（例如XML），也要首字母大写，其他字母小写(写为Xml)。

类的命名

类名称要以大写字母开头；

类名称如果包含多个单词，每个单词的首字母要大写，其他字母小写；如果这些单词是缩略

语（例如XML），也要首字母大写,其他字母小写（写作Xml）；

类名称应该是一个名词或名词短语；

类成员变量的命名规则与上述规则相同，但是要以“m_”开始，表示其为成员变量（Member）；

类名称不能出现下划线。

方法的命名

方法名称以小写字母开头。

方法名称如果包含多个单词，除了第一个单词外，每个单词的首字母大写，其它字

母小写。如果这些单词是缩略语（例如XML），也要首字母大写，其它字母小写（写作Xml）。

方法名称应该是一个动词或动名词短语，意思是“完成什么功能”，“执行什么操作”。

数据库的命名

表：

采用“模块名简称+前缀+’_’+表名”的命名规则。表名以能理解该表的内容为原则，

可由中文表示，也可由代表此表含义的英文字母组成；首字母大写；前缀代表此表类别。

视图：

采用“模块名+’_’+视图名+’视图’”的命名规则，通常由8个以内汉字组成。

存储过程：

采用“Proc+模块名+’_’+存储过程名”的命名规则。

触发器：

采用“模块名+’+触发类型+’+表名”的命名规则，如果有多个触发类型，则可以叠加在一起。

字段：

字段的命名以能理解该字段的含义为原则，通常由多个英文单词加前缀拼写而成，而组成字

段名称的首字母应大写。单词有缩写的可用缩写。字段的前缀表示该字段的数据类型，其取

值详见“数据类型”描述。原则上，字段的命名长度不超过18字节；描述字段的中文名称，

用数据库创建工具设计数据库时，需要输入。

3-参数的约定

输入参数的约定

有些函数有输入参数，这些参数指由函数外部（调用者）输入，并在函数内部使用。在函数

业务流程说明后跟输入参数说明区，用“输入参数”InputParameters或“”