代码编写规范

联众公司开发部文档《联众公司C++/C代码编写规范》

联众公司C++/C代码编写规范

版本：1.0

编写：王勇民

审查：鲍岳桥 石磊 吕翠华 高勇

批准：鲍岳桥

日期：2002/5/17

阅读人员：所有开发人员

保密级别：只限开发人员使用，严禁泄漏到公司外部，不允许带出公司

— 1 —

联众公司开发部文档《联众公司C++/C代码编写规范》

修改纪录 版本/状态 V 0.9 草稿 V1.0 正式版 作者 王勇民 王勇民 王勇民 参与者 V1.1

王勇民 与鲍岳桥、石磊、吕翠华、高勇讨论通过 2003/6/20 起止日期 2002/4/4 ~2002/4/22 2002/4/25 2002/5/16 备注 添加“代码修改规范” 此版本公司正式执行 修改6.3，和一些其他的文字错误 — 2 —

联众公司开发部文档《联众公司C++/C代码编写规范》

目录

前言 .................................................................................................................................................. 5 1． 命名规范 ........................................................................................................................... 5

1.1 变量命名 ............................................................................................................................ 5 1.2 常量命名 ............................................................................................................................ 6 1.3 函数命名 ............................................................................................................................ 6 1.4 全局函数命名 .................................................................................................................... 6 1.5 结构命名 ............................................................................................................................ 7 2． 文件设计 ........................................................................................................................... 7

2.1一个文件中只能有一个类 ................................................................................................. 7 2.2一个类至少要有一个头文件和一个执行文件 ................................................................. 7 2.3安全include ........................................................................................................................ 7 2.4最小且完全包含 ................................................................................................................. 7 2.5联众统一的文件头 ............................................................................................................. 8 2.6客户端文件命名 ................................................................................................................. 8 2.7服务器文件命名 ................................................................................................................. 8 3． 类的设计 ........................................................................................................................... 9

3.1 成员的排列顺序 ................................................................................................................ 9 3.2 在类的定义中不能有inline函数体 ........................................................................... 9 3.3 慎用友元friend ............................................................................................................ 9 3.4 尽量少的public和protected成员变量 ................................................................ 9 3.5 成员变量要赋初始值 ........................................................................................................ 9 3.6 必须有正确的拷贝构造函数和赋值函数 ...................................................................... 10 3.7 virtual关键字的使用 ....................................................................................................... 10 3.8 不允许在类中嵌套定义类 .............................................................................................. 10 3.9 注释 .................................................................................................................................. 10 3.10 文件名字 ........................................................................................................................ 11 4． 代码书写格式规范 ......................................................................................................... 11

4.1 代码的书写力求是描述性的 .......................................................................................... 11 4.2 花括号{}的使用 ............................................................................................................. 11 4.3 代码行 .............................................................................................................................. 12 4.4 空格的使用 ...................................................................................................................... 13 4.5 空行的使用 ...................................................................................................................... 13 4.6 小括号 () 的使用 ......................................................................................................... 14 4.7 注释的使用 ...................................................................................................................... 14 4.8 长行拆分 .......................................................................................................................... 14 4.9 修饰符* &的位置 ............................................................................................................ 15 4.10 注意代码中不要误写全角字符 .................................................................................... 15 5． 函数设计 ......................................................................................................................... 15

5.1 通用规则 .......................................................................................................................... 15 5.2 参数的规则 ...................................................................................................................... 16 5.3 返回值规则 ...................................................................................................................... 16 5.4 函数体编写规则 .............................................................................................................. 16

— 3 —

联众公司开发部文档《联众公司C++/C代码编写规范》

5.5 使用ASSERT .................................................................................................................. 17 5.6 使用const增强程序的健壮性 ....................................................................................... 17 5.7 禁用goto语句................................................................................................................. 17 6． 指针的使用 ..................................................................................................................... 18

6.1 指针声明后必须先置为NULL ...................................................................................... 18 6.2 类里的成员指针在删除后必须置为NULL .................................................................. 18 6.3 指针在使用前判断是否有效 .......................................................................................... 18 6.4 给指针分配的内存要释放 .............................................................................................. 19 6.5 避免指针所指的对象已经不在了还操作指针 .............................................................. 19 7． 避免数组访问的越界 ..................................................................................................... 19 8． 代码修改规范 ................................................................................................................. 19 9． 其他 ................................................................................................................................. 20

— 4 —

联众公司开发部文档《联众公司C++/C代码编写规范》

前言

为了规范化本公司C++/C程序代码的书写，便于交流和减少程序中隐藏测错误，故整理编写了此规范文件，不妥之处和欠缺的地方请大家提出。所有开发人员必须遵守此规范。

1． 命名规范

1.1 变量命名

? 变量命名参照匈牙利命名法则做如下约定： 小写前缀 类型 a array, [] a2 2 dimension array, [][] a3 3 dimension array, [][][] b BOOL by BYTE c char ch char cn int d double dw DWORD f float h HANDLE i INT,int l LONG,long n UINT,usigned int p pointer s/str CString sz string terminated by zero, char[] u unsigned w WORD g_ global m_ member ms_ static member s_ static st struct cls class

— 5 —

说明 计数器 全局变量前缀 类的成员变量前缀 类的静态成员变量 静态变量前缀