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

 

 

时间: 2024-11-08 23:23:02

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

《C++编程规范:101条规则、准则与最佳实践》——1.2:在高警告级别干净利落地进行编译

1.2:在高警告级别干净利落地进行编译 摘要高度重视警告:使用编译器的最高警告级别.应该要求构建是干净利落的(没有警告).理解所有的警告.通过修改代码而不是降低警告级别来排除警告. 讨论编译器是你的朋友.如果它对某个构造发出警告,一般表明代码中存有潜在的问题. 成功的构建应该是无声无息的(没有警告的).如果不是这样,你很快就会养成不仔细查看输出的习惯,从而漏过真正的问题(见第2条). 排除警告的正确做法是:(1)把它弄清楚:然后,(2)改写代码以排除警告,并使代码阅读者和编译器都能更加清楚,代码

《C++编程规范:101条规则、准则与最佳实践》——导读

前言 C++编程规范:101条规则.准则与最佳实践尽早进入正轨:以同样的方式实施同样的过程.不断积累惯用法.将其标准化.如此,你与莎士比亚之间的唯一区别将只是掌握惯用法的多少,而非词汇的多少. --Alan Perlis[1]} 标准最大的优点在于,它提供了如此多样的选择. --出处尚无定论 我们之所以编写本书,作为各开发团队编程规范的基础,有下面两个主要原因. 编程规范应该反映业界最久经考验的经验.它应该包含凝聚了经验和对语言的深刻理解的公认的惯用法.具体而言,编程规范应该牢固地建立在大量丰富

11个PHPer必须要了解的编程规范_php技巧

本文将讨论常用的良好的代码习惯,或者称为代码规范,在PHP领域. 1,错误报告开启 错误报告是在PHP中一个非常有用的功能,应同时在开发阶段启用. 这可以帮助我们确定我们的代码中的问题. 最常用的功能是"E_ALL",这有助于我们发现所有的警告和严重错误. 必须指出的是,我们把我们的代码投入上线前,我们应该关闭这个功能提示,否则会在浏览器上的暴漏所有潜在错误及警告. 2,使用DRY原则 'Do not Repeat Yourself',DRY原则指的是不要重复你的代码.. 这个概念是一

JAVA 编程规范

编程|规范 1. 应用范围 本规范应用于采用J2EE规范的项目中,所有项目中的JAVA代码(含JSP,SERVLET,JAVABEAN,EJB)均应遵守这个规范.同时,也可作为其它项目的参考. 2. 设计类和方法 2.1 创建具有很强内聚力的类 方法的重要性往往比类的重要性更容易理解,方法是指执行一个统一函数的一段代码.类常被错误的视为是一个仅仅用于存放方法的容器.有些开发人员甚至把这种思路作了进一步的发挥,将他们的所有方法放入单个类之中. 之所以不能正确的认识类的功能,原因之一是类的实现实际上

Visual Basic编程规范

visual|编程|规范 Visual Basic编程规范 1.      Visual Basic IDE(集成开发环境)设置        必须打开设置选项的"要求变量声明","对齐控件到网格","自动缩进"开关.        Tab的宽度统一为4个空格,网格单位一律设为:width 60 height 60. 2.     命名约定        (注意:在任何时候,不能使用中文及全角字符,只允许使用英文字母.下划线和数字) 2.1   

IDesign C#编程规范(之四)

编程|规范 续之三,本文是IDesign C#编程规范的第三章. 3 项目设置和项目结构 Project Settings and Project Structure 1. 总是以4级警告建立项目(图略). Always build your project with warning level 4 2. 在发布版中将警告作为错误(注意这不是VS.NET的缺省设置)(图略). Treat warning as errors in Release build (note that this is

大话数据库编程规范

1.1 前言 目前在软件圈内有这么一个现象,就是:DBA不太懂写PL/SQL,而开发人员写的又是五花八门,而且效率不高.如此以来,造成诸多弊端: 1.可读性差.读别人写的一个程序花费的时间,比自己写一个程序的花费时间还要长:非但别人看不懂,时间久了连自己也看不懂了. 2.可维护性差.程序越写越长,越改越烂,像懒婆娘的裹脚布,又臭又长. 3.可移植性差.今天用oracle写一套,明天换成SQL Server的时候再写一套,众多的数据库开发人员在程序的苦海中重复着低级劳动-- 4.效率和性能差.一个

IOS团队编程规范

本文讲的是IOS团队编程规范,需求是暂时的,只有变化才是永恒的,面向变化编程,而不是面向需求编程. 不要过分追求技巧,降低程序的可读性. 简洁的代码可以让bug无处藏身.要写出明显没有bug的代码,而不是没有明显bug的代码. 先把眼前的问题解决掉,解决好,再考虑将来的扩展问题. 一.命名规范 1.统一要求 含义清楚,尽量做到不需要注释也能了解其作用,若做不到,就加注释,使用全称,不使用缩写. 2.类名 大驼峰式命名:每个单词的首字母都采用大写字母 ==例:== MFHomePageViewCo

《C++编程规范:101条规则、准则与最佳实践》——第2章设计风格设计风格 C++编程规范:101条规则、准则与最佳实践 复杂性啊,愚人对你视而不见,实干家受你所累。 有些人避而远之。惟智者能够善加消除。 ——Alan Perlis 我知道,但是却又忘记了Hoare的至理名言:不成熟的优化是程

第2章设计风格 C++编程规范:101条规则.准则与最佳实践 复杂性啊,愚人对你视而不见,实干家受你所累. 有些人避而远之.惟智者能够善加消除. --Alan Perlis 我知道,但是却又忘记了Hoare的至理名言:不成熟的优化是程序设计中的万恶之源. --Donald Knuth[1] The Errors of TeX[Knuth89] 完全区分设计风格与编码风格是非常困难的.我们将一般在实际编写代码时才用得到的条款留到下一部分介绍. 本部分集中讨论适用面比一个特定的类或者函数更广的原则和