CC++语言软件编程规范.docx

1、CC+语言软件编程规范C+语言编程规范目 次前言 II1 范围 12 规范性引用文件 13 术语和定义 14 文件结构 14.1 概述 14.2 版权和版本的声明 14.3 头文件的结构 24.4 定义文件的结构 25 程序的版式 35.1 空行 35.2 代码行 35.3 代码行内的空格 45.4 对齐 55.5 长行拆分 65.6 注释 66 命名规则 96.1 共性规则 96.2 一般命名规则 107 其它规则 127.1 布尔变量与零值比较 127.2 整型变量与零值比较 127.3 浮点变量与零值比较 127.4 指针变量与零值比较 12附录A （资料性附录） 良好的C/C+编程风格

2、 14A.1 表达式和基本语句 14A.2 变量、结构与数据类型 16A.3 常量 21A.4 函数 22A.5 宏 26A.5.1 用宏定义表达式时，应使用完备的括号。 26A.6 可测性 27A.6.2 使用断言 27A.7 质量保证 31前 言本标准的附录A为资料性附录。C/C+语言编程规范范围本标准规定了软件编程中程序文件的结构和编程风格方面的一些规则。本标准适用于C/C+编程。规范性引用文件下列文件中的条款通过本标准的引用而成为本标准的条款。凡是注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本标准，然而，鼓励根据本标准达成协议的各方研究是否可使用这些文件的

3、最新版本。凡是不注日期的引用文件，其最新版本适用于本标准。GB/T 5271.1-2000 信息技术 词汇 第1部分：基本术语GB/T 5271.7-1986 数据处理词汇 07部分：计算机程序设计GB/T 5271.15-1986 数据处理词汇 15部分：程序设计语言术语和定义GB/T 5271.1、GB/T 5271.7和GB/T 5271.15确立的术语和定义适用于本标准。文件结构概述每个C/C+程序应至少包括两类文件。一个文件用于保存程序的声明，称为头文件。另一个文件用于保存程序的实现，称为定义文件。C/C+程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀，C+程序的定义

4、文件通常以“.cpp”为后缀（也有一些系统以“.cc”或“.cxx”为后缀）。版权和版本的声明/* Copyright (c) 2001, * All rights reserved.* * 文件名称：filename.h* 摘 要：简要描述本文件的内容* 版本号：1.2 作者：作者（修改者） 完成日期：2003年7月20日* * 版本号：1.1 作者：作者（修改者） 完成日期：2003年5月20日* 版本号：1.0 作者：作者（修改者） 完成日期：2003年2月20日*/版权和版本的声明版权和版本的声明位于头文件和定义文件的开头（见图1），主要内容有：版权信息；文件名称，摘要；当前版本号，作

5、者/修改者，完成日期；版本历史信息。头文件的结构概述头文件由三部分内容组成：头文件的版权和版本声明（见图1）；预处理块；函数和类结构声明等。若头文件名称为 graphics.h，头文件的结构见图2。/ 版权和版本声明见图1#ifndef GRAPHICS_H / 防止graphics.h被重复引用#define GRAPHICS_H#include / 引用标准库的头文件#include “myheader.h” / 引用非标准库的头文件void Function1(); / 全局函数声明class Box / 类结构声明; / 其它#endifC/C+头文件的结构为了防止头文件被重复引用，应

6、当用ifndef/define/endif结构产生预处理块。用 #include 格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。用 #include “filename.h” 格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。头文件中宜只存放“声明” 而不存放“定义”。不提倡使用全局变量，不宜在头文件中出现extern int value 这类声明。定义文件的结构定义文件有三部分内容：定义文件的版权和版本声明（见图1）；对一些头文件的引用；程序的实现体（包括数据和代码）。若定义文件的名称为 graphics.cpp，定义文件的结构见图3。/ 版权和版本声明见图1#in

7、clude “graphics.h” / 引用头文件/ 全局函数的实现体void Function1()/ 类成员函数的实现体void Box:Draw()C/C+定义文件的结构程序的版式空行在变量声明之后、每个类声明之后和每个函数定义结束之后应加空行(见图4(左)。在一个函数体内，逻揖上密切相关的语句之间应不加空行，其它地方应加空行分隔(见图4(右) 。/ 空行void Function1() / 空行void Function2() / 空行void Function3() / 空行while (condition) statement1; / 空行 if (condition) stat

8、ement2; else statement3; / 空行 statement4; 函数之间的空行(左)，函数内部的空行(右)代码行一行代码宜只做一件事情，如只定义一个变量，或只写一条语句(见图5)。if、for、while、do等语句应自占一行，执行语句不应紧跟其后。不论执行语句有多少都应加(见图5)。int width; / 宽度int height; / 高度int depth; / 深度int width, height, depth; / 宽度高度深度x = a + b;y = c + d;z = e + f;X a + b; y = c + d; z = e + f;if (wid

9、th height) dosomething();if (width = 2000) / 良好的风格if(year=2000) / 不良的风格if (a=b) & (c=b&c=d) / 不良的风格for (i=0; i10; i+) / 良好的风格for(i=0;i10;i+) / 不良的风格for (i = 0; I 10; i +) / 过多的空格x = a b ? a : b; / 良好的风格x=aFunction(); / 不应写成 b - Function();代码行内的空格关键字之后应留空格。如if、for、while等关键字之后应留一个空格再跟左括号（，以突出关键字。函数名之后

10、应不留空格，紧跟左括号（，以与关键字区别。（后面应不留空格，）、，、;前面应不留空格。，之后应留空格，如Function(x, y, z)。若;不是一行的结束符号，其后应留空格，如for (initialization; condition; update)。赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“=”、“+=” “=”、“=”、“+”、“*”、“%”、“&”、“|”、“”等操作符前后应不加空格。对于表达式比较长的for语句和if语句，为了紧凑起见可以适当地去掉一些空格，如for (i=0; i10; i+)和if (a=b) & (c= very_longer_var

11、iable12)& (very_longer_variable3 = very_longer_variable14)& (very_longer_variable5 Draw(); / 类的成员函数宜用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。：int minValue;int maxValue;int SetValue();int GetValue();下面是一些在软件中常用的反义词组。add / remove begin / end create / destroy insert / delete first / last get / releaseincrement / d

12、ecrement put / getadd / delete lock / unlock open / closemin / max old / new start / stopnext / previous source / target show / hidesend / receive source / destinationcut / paste up / down尽量避免名字中出现数字编号，如Value1,Value2等，除非逻辑上的确需要编号。在同一软件产品内，应规划好接口部分标识符（变量、结构、函数及常量）的命名，防止编译、链接时产生冲突。对接口部分的标识符应该有更严格限制，防止

13、冲突。如可规定接口部分的变量与常量之前加上“模块”标识等。一般命名规则类名和函数名、结构名、typedef的名用大写字母开头的单词组合而成。：class Node; / 类名class LeafNode; / 类名void Draw(void); / 函数名void SetValue(int value); / 函数名typedef struct STUDENT; /typedef变量和参数应用小写字母开头的单词组合而成。：BOOL flag;int drawMode;常量应全用大写的字母，并用下划线分割单词。：const int MAX = 100;const int MAX_LENGTH = 100;静态变量应加前缀s_（表示static）。：void Init() static int s_initValue; / 静态变量 若必须使用全局变量，则全局变量应加前缀g_（表示global）。：int g_howManyPeople; / 全局变量int g_howMuchMoney; / 全局变量类的数据成员应加前缀m_（表示member），以避免数据成员与成员函数的参数同名。： void Object:SetValue(int width,