C++ 编 码 规 范
1 前言
本编码规范针对C++语言。制定本规范的目的:提高代码的健壮性,使代码更安全、可靠;提高代码的可读性,使代码易于查看和维护。
本文档分别对C++程序的格式、注释、标识符命名、语句使用、函数、类、程序组织、公共变量等方面做出了要求。规范分为两个级别——规则和建议。规则级的规范要求开发人员必须要遵守,建议级的规范开发人员应尽量遵守。
各项目组在用C++语言或基于C++语言的开发工具开发项目时,要遵守本规范。
2 编码规范正文
以下是各条规范的具体内容。
2.1格式
对代码书写格式的要求。
2.1.1 空行的使用
规范级别:规则 规则描述:
●在头文件和实现文件中,各主要部分之间要用空行隔开。 所谓文件的主要部分,包括:序言性注释、防止被重复包含部分(只在头文件中)、# include部分、#define部分、类型声明和定义部分、实现部分等等。 ●在一个函数中,完成不同功能的部分,要用空行隔开。 理由:
段落分明,提高代码的可读性。
2.1.2 哪里应该使用空格
规范级别:规则 规则描述:
●在使用赋值运算符、逻辑运算符、位运算符、算术运算符等二元操作符时,在其两边各加一个空格。
例: nCount = 2;而不是 nCount=2;
● 函数的各参数间要用“,”和一个空格隔开。
例:void GetDate(int x, int y);
而不是void GetDate(int x,int y)或void GetDate(int x ,int
y)。 理由:
提高代码的可读性。