Windows客户端C/C++编程规范“建议”——变量和常量

8 变量和常量

8.1 尽量不要使用全局变量

等级:【要求】

说明:全局变量的滥用和goto的滥用一样,都是一种灾难。它将使得逻辑变得难以调试和控制。

8.2 不涉及外部使用的全局变量需要使用static关键字修饰

等级:【要求】

说明:这样可以避免冲突。

8.3 变量需初始化后才能使用

等级:【必须】

说明:变量最好在定义时初始化。如果定义时无法初始化,那就应该在定义后立即初始化。

以下我们来分析下变量未初始化而被使用的场景:

在debug环境下,我们声明一个变量,编译器会使用0xCC填充变量所在空间。而在Release环境下,变量所在空间是不会被初始化的。所以我们经常会发现一些奇怪的现象:在debug环境下逻辑是正确的,release环境下逻辑是错误的。

变量没有初始化存在如下危害:

  1. 产生脏数据。由于变量空间没有初始化,会导致脏数据的产生。可以见下例。
  2. 影响正常逻辑。脏数据将会导致之后使用相关数据的地方出现逻辑错误。
  3. 间接导致崩溃。可以见下例:
void MyPrintf( char* p ) {
	strcat(p, "abcdefghijklmnopqrstuvwxyz");
	printf("%s", p);
}

int _tmain(int argc, _TCHAR* argv[])
{
	char szBuffer[32];
	std::string str = "01234";
	memcpy_s( szBuffer, _countof(szBuffer), str.c_str(), str.length() );
	MyPrintf(szBuffer);
	return 0;
}

该例中,栈上分配了一段32字节的空间。由于该空间没有初始化,所以在一定概率下,这段内存中不会出现0x00。于是之后的strcat将会导致堆栈溢出。我这儿将strcat放到一个函数内部,是为了比较方便的触发崩溃。

执行strcat后。

基于以上危害,我们在申明变量时需要初始化。类的成员变量,需要在构造函数中初始化。

这儿有个需要特别说明的,静态数组初始化请使用:

char szPath[MAX_PATH] = {0};

而以下这种写法就没有上面这种写法方便和效率高:

char szPath[MAX_PATH];
memset( szPath, 0, sizeof(szPath) );

8.4 一行只定义一个变量

等级:【要求】

说明:一行只定义一个变量,将会使的变量的初始化、维护变得方便。

8.5 不要直接使用常量参与运算

等级:【必须】

说明:在代码逻辑中直接使用常量,将导致代码逻辑非常难读懂。因为常量不具有表意性。

例子:

RECT mainrc;
mainrc.left += 124;
mainrc.top += 56;

该例子,试图计算出一个窗口中某个控件的位置(无窗口控件)。但是对于第一次读这样的代码的同学,谁知道那两个常量是什么意思?可以这么修改:

RECT mainrc;
const unsigned int unCloseBtnOffX = 124;
const unsigned int unCloseBtnOffY = 56;
mainrc.left += unCloseBtnOffX;
mainrc.top += unCloseBtnOffY;

8.6 变量定义在接近第一次使用处(C除外)

等级:【要求】

说明:这样设计将使得代码可读性加强。

(转载请指明出于breaksoftware的csdn博客)

时间: 2024-10-12 12:49:44

Windows客户端C/C++编程规范“建议”——变量和常量的相关文章

Windows客户端C/C++编程规范“建议”——前言

前言 工作中接触了很多编程规范.其中最有意思的是,公司最近发布了一版C/C++编程规范,然后我看到该规范的最后一段时,有这么一句:"该规范不适用于Windows平台开发".看来这份规范是由做其他平台开发的同学制定的.那么做Windows开发的人都去哪儿了?后来由于工作需要,项目组需要我制定一份编程规范.这也是我这系列博客的由来.(转载请指明出于breaksoftware的csdn博客) 说到"规范"",可能没多少人喜欢这样的东西.相信很多工程师和我一样,都

Windows客户端C/C++编程规范“建议”——函数

1 函数 1.1 代码行数控制在80行及以内 等级:[要求] 说明:每个函数的代码行数控制应该控制在80行以内.如果超过这个限制函数内部逻辑一般可以拆分.如果试图超过这个标准,请列出理由.但理由不包含如下: 无法拆分. 流程内部逻辑复杂,无需拆分,即使拆分了,拆分的函数也不会被其他地方用到.(解释:拆分可以减少代码行数,提炼后的函数可以方便读者快速理解函数逻辑并定位问题.) 1.2 代码列数控制在100字符及以内 等级:[要求] 说明:每行代码不可以超过100字符.如果超过这个字符数,代码的美观

Windows客户端C/C++编程规范“建议”——指针

2 指针 2.1 尽量使用智能指针 等级:[推荐] 说明:正确使用智能指针可以省去指针管理的工作. 2.2 类成员变量指针释放后一定要置空 等级:[必须] 说明:如果类成员变量指针在释放后没有置空,将出现如下问题: a) 无法判断指针是否已经是野指针 b) Dump分析很难发现是野指针函数调用导致崩溃 2.3 正确使用delete和delete[] 等级:[必须] 说明:delete[]用于释放动态分配的数组,而delete用于释放对象.两者不可以混用. 2.4 使用指针前要判空 等级:[必须]

Windows客户端C/C++编程规范“建议”——函数调用

3 函数调用 3.1 谨慎使用递归方法 等级:[推荐] 说明:递归方式控制不当,可能会导致栈空间不够而崩溃.一般的递归都可以使用循环代替. 3.2 不要使用using namespace 等级:[必须] 说明:这是曾经教科书上的一种写法,但是该方法存在严重的缺陷.因为如果多个不同的namespace里定义了相同名字的变量或者函数.将导致无法预知和理解编译器最终使用的是哪个命名空间中的数据. 例子: //file1 namespace Space1{ int g_Private = 0; }; /

Windows客户端C/C++编程规范“建议”——表达式和运算

4 表达式和运算 4.1 比较操作中将常量设置为左值 等级:[推荐] 说明:编写代码时,如果将常量设置为右值.可能因马虎将"=="写成"="导致逻辑错误.这种场景下,编译器是不会报错的,代码检查也比较容易被忽视. 例子: std::string::size_type index = str.find("a"); if ( index = std::string::npos){ } 上例中写法可以执行,但是逻辑是错的.如下编写,可以借助编译器检查出

Windows客户端C/C++编程规范“建议”——宏

6 宏 6.1 减少宏的使用 等级:[建议] 说明:宏的使用,将使得调试变得麻烦.所以在设计和使用宏的时候,请确保宏的逻辑是阅读者不会去关心细节的行为. 6.2 宏定义中字母需大写 等级:[必须] 说明:为了醒目表示它是一个宏,而不是一个函数. 6.3 使用const变量代替宏定义值 等级:[建议] 说明:在一个函数体内部使用的常量,最好使用const变量替代,而不是使用宏. 6.4 使用枚举代替一系列有关联的宏 等级:[建议] 说明:比如一个函数返回一系列表示状态的宏,则应该使用枚举类型替代.

Windows客户端C/C++编程规范“建议”——文件

7 文件 7.1 正确使用#include 等级:[推荐] 说明:#include <>和#include ""导致编译器在搜索文件时,搜索的路径顺序不同.所以需要正确使用#include,以避免包含错了头文件. 语法形式 操作 带引号的形式 预处理器按以下顺序搜索包含文件: 在包含 #include 语句的文件所在的同一目录中. 在当前打开的包含文件的目录中,采用与打开它们的顺序相反的顺序. 搜索从父包含文件的目录中开始进行,然后继续向上到任何祖父包含文件的目录. 跟随每

Windows客户端C/C++编程规范“建议”——结构

5 结构 5.1 不要使用goto 等级:[必须] 说明:在大型项目中,goto的滥用会导致灾难性后果.因为我们程序中一般不存在从一个函数体内部跳转到另一个函数体内部的场景,所以我们可以将跳转控制在函数内部,从而避免灾难. 例子: do { if ( False ) { break;// 相当于goto } } while (0); 5.2 不要利用异常机制实现流程的跳转 等级:[必须] 说明:该方法比较常见于防逆向等方面,但是我们普通编程方式应该严禁使用.否则将增加代码阅读的难度. (转载请指

Windows客户端C/C++编程规范“建议”——风格

9 风格 9.1 优先使用匈牙利命名法 等级:[推荐] 说明:该方法由微软总设计师设计.Windows上编程最好遵从该标准.详细介绍见:http://zh.wikipedia.org/wiki/%E5%8C%88%E7%89%99%E5%88%A9%E5%91%BD%E5%90%8D%E6%B3%95 9.2 变量名结合使用匈牙利命名法和驼峰命名法 等级:[推荐] 说明:比如 int nMaxCount = 1;中变量前缀n表示int型变量,MaxCount是表意,其就是使用驼峰命名法(首字母大