C++编程规范之1:在高警告级别干净利落地进行编译

简介:


原则:

高度重视警告:使用编译器的最高警告级别。应该要求构建是干净利落的(没有警告)。理解所有的警告。通过修改代码而不是降低警告级别来排除警告。

解释:

编译器是你的朋友。如果它对某个构造发出警告,一般表明代码中存有潜在的问题。

成功的构建应该是无声无息的(没有警告的)。如果不是这样,你很快就会养成不仔细查看输出的习惯,从而漏过真正的问题。

排除警告的正确做法是:(1)把它弄清楚;(2)改写代码以排除警告,并使代码阅读者和编译器都能更加清楚,代码是按编写者的意图执行的。

即使程序一开始似乎能够正确运行,也还是要这样做。即使你能够肯定警告是良性的,仍然要这样做。因为良性警告的后面可能隐藏着未来指向真正危险的警告。

示例:

1.             第三方头文件。

无法修改库头文件可能包含引起警告(可能是良性的)的构造。如果这样,可以用自己的包含头文件的版本将次文件包装起来,并有选择的为该作用域关闭烦人的警告,然后在真个项目的其他地方包含此包装文件。

2.             未使用函数参数。

检查一下,确认确实不需要使用该函数参数(比如,这可能是一个为了未来扩展而设的占位符,或者是代码没有使用的标准化函数签名中的一个必需部分)。如果确实不需要,那直接删除函数参数名就行了。

	//。。。。在一个用户定义的allocator中未使用hint。。。。。
	//警告:unused parameter 'localityHint'
	pointer allocate(size_type numObjects,const void *localityHint = 0)
	{
		return static_case<pointer>(mallocShared(numObjects *sizeof(T)));
	}
	
	//消除了警告的新版本
	pointer allocate(size_type numObjects,const void * /*localityHint*/ = 0)
	{
		return static_case<pointer>(mallocShared(numObjects *sizeof(T)));
	}


3.             定义了从未使用的变量

检查一下,确认并不是真正要引用该变量。如果确实不需要,经常可以通过插入一个本身的求职表达式,使编译器不再报警。

	//警告:variable 'lock' is defined but never used
	void Fun()
	{
		Lock lock;
		//......
	}

	//可能消除了警告的新版本
	void Fun()
	{
		Lock lock;
		lock;//这一句是关键
		//......
	}


4.             变量使用前可能未经初始化

需要初始化变量

5.             遗漏了return语句

有时候编译器会要求每个分支都有return语句,即使控制流可能永远也不会到达函数的结尾。这可能是一件好事,因为有时候你仅仅是认为控制不会运行到结尾。例如,没有default情况的switch语句不太适应变化,应该加上执行assert(false) 的default情况。

	//警告:missing "return"
	int Fun(color c)
	{
		switch(c)
		{
		case Red:
			return 2;
		case Green:
			return 0;
		case Blue:
		case Black:
			return 1;
		}
	}

	//消除了警告的版本
	int Fun(color c)
	{
		switch(c)
		{
		case Red:
			return 2;
		case Green:
			return 0;
		case Blue:
		case Black:
			return 1;
		default:
			assert(!"should never get here!")//!"string"的求值结果为false
				return -1;
		}
	}


6.             有符号/无符号数不匹配

通常没有必要对符号不同的整数进行比较和赋值。应该改变所操作的变量的类型,从而使类型匹配。最坏的情况下,要插入一个显示的强制转换。

    7.有时候编译器可能会发出烦人的甚至虚假的警告(即纯属噪声的警告),但是又没有提供消除的方法,这时忙于修改代码解决这个警告可能是劳而无功或者事倍功半的。如果遇到了这种罕见的情形,作为团队决定,应该避免对纯粹无益的警告再做无用功:单独禁用这个警告,但是要尽可能在局部禁用,并且编写一个清晰的注释,说明为什么必须禁用。

 

 

相关文章
|
26天前
|
自然语言处理 编译器 Linux
|
5月前
|
消息中间件 Java C语言
消息队列 MQ使用问题之在使用C++客户端和GBase的ESQL进行编译时出现core dump,该怎么办
消息队列(MQ)是一种用于异步通信和解耦的应用程序间消息传递的服务,广泛应用于分布式系统中。针对不同的MQ产品,如阿里云的RocketMQ、RabbitMQ等,它们在实现上述场景时可能会有不同的特性和优势,比如RocketMQ强调高吞吐量、低延迟和高可用性,适合大规模分布式系统;而RabbitMQ则以其灵活的路由规则和丰富的协议支持受到青睐。下面是一些常见的消息队列MQ产品的使用场景合集,这些场景涵盖了多种行业和业务需求。
|
1月前
|
自然语言处理 编译器 Linux
告别头文件,编译效率提升 42%!C++ Modules 实战解析 | 干货推荐
本文中,阿里云智能集团开发工程师李泽政以 Alinux 为操作环境,讲解模块相比传统头文件有哪些优势,并通过若干个例子,学习如何组织一个 C++ 模块工程并使用模块封装第三方库或是改造现有的项目。
|
2月前
|
存储 程序员 编译器
简述 C、C++程序编译的内存分配情况
在C和C++程序编译过程中,内存被划分为几个区域进行分配:代码区存储常量和执行指令;全局/静态变量区存放全局变量及静态变量;栈区管理函数参数、局部变量等;堆区则用于动态分配内存,由程序员控制释放,共同支撑着程序运行时的数据存储与处理需求。
116 21
|
2月前
|
Linux 编译器 C语言
Linux c/c++之多文档编译
这篇文章介绍了在Linux操作系统下使用gcc编译器进行C/C++多文件编译的方法和步骤。
42 0
Linux c/c++之多文档编译
|
2月前
|
算法 编译器 C++
【C++篇】领略模板编程的进阶之美:参数巧思与编译的智慧
【C++篇】领略模板编程的进阶之美:参数巧思与编译的智慧
82 2
|
5月前
|
C++ 运维
开发与运维编译问题之在C++中在使用std::mutex后能自动释放锁如何解决
开发与运维编译问题之在C++中在使用std::mutex后能自动释放锁如何解决
69 2
|
5天前
|
存储 编译器 C语言
【c++丨STL】string类的使用
本文介绍了C++中`string`类的基本概念及其主要接口。`string`类在C++标准库中扮演着重要角色,它提供了比C语言中字符串处理函数更丰富、安全和便捷的功能。文章详细讲解了`string`类的构造函数、赋值运算符、容量管理接口、元素访问及遍历方法、字符串修改操作、字符串运算接口、常量成员和非成员函数等内容。通过实例演示了如何使用这些接口进行字符串的创建、修改、查找和比较等操作,帮助读者更好地理解和掌握`string`类的应用。
19 2
|
11天前
|
存储 编译器 C++
【c++】类和对象(下)(取地址运算符重载、深究构造函数、类型转换、static修饰成员、友元、内部类、匿名对象)
本文介绍了C++中类和对象的高级特性,包括取地址运算符重载、构造函数的初始化列表、类型转换、static修饰成员、友元、内部类及匿名对象等内容。文章详细解释了每个概念的使用方法和注意事项,帮助读者深入了解C++面向对象编程的核心机制。
37 5
|
17天前
|
存储 编译器 C++
【c++】类和对象(中)(构造函数、析构函数、拷贝构造、赋值重载)
本文深入探讨了C++类的默认成员函数,包括构造函数、析构函数、拷贝构造函数和赋值重载。构造函数用于对象的初始化,析构函数用于对象销毁时的资源清理,拷贝构造函数用于对象的拷贝,赋值重载用于已存在对象的赋值。文章详细介绍了每个函数的特点、使用方法及注意事项,并提供了代码示例。这些默认成员函数确保了资源的正确管理和对象状态的维护。
48 4