语言编码规范.doc

C语言编码规范
文档修改记录
版本
版本日期
说明
编写者
审核者

吕晓敏
排版规则
程序应采用缩进风格编写,每层缩进使用一个制表位(TAB),类定义、方法都应顶格书写;
源程序建议使用英文书写,尽量不含有中文。每行不超过80字符。对于较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读;循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分;
左花括号要另起一行,不能跟在上一行的行末;
一个变量定义占一行,一个语句占一行;
对独立的程序块之间、变量说明之后必须加空行;
在结构成员赋值等情况,等号对齐,最少留一个空格;
若函数或过程中的参数较长,则要进行适当的划分。
形参的排序风格:
最常使用的参数放在第一位;
输入参数列表应放在输出参数列表的左边;
将通用的参数放在特殊的参数的左边。
命名规范
应用程序的命名
“系统简称”+模块名称
子模块的命名
每个子模块的名字应该由描述模块功能的1-3以单词组成。每个单词的首字母应大写。在这些单词中可以使用一些较通用的缩写。
变量的命名
变量的命名的基本原则是使得变量的含义能够从名字中直接理解。可以用多个英文单词拼写而成,每个英文单词的首字母要大写,其中英文单词有缩写的可用缩写;变量的前缀表示该变量的类型;对于作用域跨越10行以上的变量名称不能少于4个字符,除循环变量,累加变量外不得使用I、j、k等名称的变量。变量分为取全局变量和局部变量,对于全局变量以加前缀“g_”来区分。
使用有意义的英语单词,使用大小写分隔,每个单词的第一个字母为大写
标识符种类
书写规范
示例
函数/过程名/变量
一般标识符
CheckButtonStates
宏标识符
大写标识符
SALES_TAX
类型定义
‘T’+一般标识符
TMyType
类标识符
‘C’+一般标识符
CEditBox
结构标识符
‘S’+一般标识符
SMyStructure
联合标识符
‘U’+一般标识符
UMyUnion
字符标识符
‘c’+一般标识符
cReadKey
字符串标识符
‘s’+一般标识符
sComputerName
整数标识符
‘i/ui/l/ul’+一般标识符
iNumber, ulCurrent
浮点型标识符
‘f/d’+一般标识符
fPrice,dMoney
逻辑标识符
‘b’+一般标识符
bIsDetailed
对象标识符
特征小写字母+一般标识符
fMyStatus, tMyTree
指针变量
p+类型前缀+一般标识符
piCount
全局变量
g+类型前缀+一般标识符
giCount
类私有变量
f+类型前缀+一般标识符
fiCount
数据库变量
以m打头
miCount
考虑到****惯性和简洁性,对于按常规使用的局部变量允许采用极短的名字,如用n、i作为循环变量,p、q作为指针等。另外,要注意的是:全局变量在程序中不要定义太多,能用局部变量的就用局部变量。如果要使用相关的变量,建议采用类的方式或者结构的方式存放,以减少具体变量的个数。
常量的命名
常量所有的字母均为大写。并且单词之间使用下划线”_”隔开。
函数/过程的命名
函数/过程名称应该尽量使用能够表达函数功能的英文名称,函数名称中应该禁止使用如同function1,function2等含义不清的名称。单词间应该使用大小写分隔。全局函数/过程名称以“g_”前缀开始。
接口命名
接口名称要以大写字母开头。如果接口包含多个单词,每个单词的首字母大写,其他字母小写,如果,这些单词是缩略语(例如XML),也要首字母大写,其他字母小写(写为Xml)。
类的命名
类名称要以大写字母开头;
类名称如果包含多个单词,每个单词的首字母要大写,其他字母小写;如果这些单词是缩略语(例如XML),也要首字母大写,其他字母小写(写作Xml);
类名称应该是一个名词或名词短语;
类成员变量的命名规则与上述规则相同,但是要以“m_”开始,表示其为成员变量(Member);
类名称不能出现下划线。
方法的命名
方法名称以小写字母开头。
方法名称如果包含多个单词,除了第一个单词外,每个单词的首字母大写,其它字
母小写。如果这些单词是缩略语(例如XML),也要首字母大写,其它字母小写(写作Xml)。
方法名称应该是一个动词或动名词短语,意思是“完成什么功能”,“执行什么操作”。
数据库的命名
表:
采用“模块名简称+前缀+’_’+表名”的命名规则。表名以能理解该表的内容为原则,