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

1.2:在高警告级别干净利落地进行编译

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

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

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

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

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

示例
例1 第三方头文件。无法修改的库头文件可能包含引起警告(可能是良性的)的构造。如果这样,可以用自己的包含原头文件的版本将此文件包装起来,并有选择地为该作用域关闭烦人的警告,然后在整个项目的其他地方包含此包装文件。例如(请注意,各种编译器的警告控制语法并不一样):

// 文件:myproj/my_lambda.h —— 包装了Boost的lambda.hpp
// 应该总是包含此文件,不要直接使用lambda.hpp。
// 注意:我们的构建现在会自动检查grep lambda.hpp <srcfile>。
// Boost.Lambda 会产生一些已知无害的编译器警告。
// 在改正以后,我们将删除以下的编译指示,但此头文件仍然存在。
//
#pragma warning(push)  // 仅禁用此头文件
 #pragma warning(disable:4512)
 #pragma warning(disable:4180)
 #include <boost/lambda/lambda.hpp>
#pragma warning(pop)   // 恢复最初的警告级别```
例2 “未使用的函数参数”(Unused function parameter)。检查一下,确认确实不需要使用该函数参数(比如,这可能是一个为了未来扩展而设的占位符,或者是代码没有使用的标准化函数签名中的一个必需部分)。如果确实不需要,那直接删除函数参数名就行了。

// ……在一个用户定义的allocator中未使用hint ……
// 警告:unused parameter 'localityHint
pointer allocate( size_type numObjects, const void *localityHint = 0 ) {
 return static_cast( mallocShared( numObjects * sizeof(T) ) );
}
// 消除了警告的新版本
pointer allocate( size_type numObjects, const void / localityHint */ = 0 ) {
 return static_cast( mallocShared( numObjects * sizeof(T) )  );
}`
例3 “定义了从未使用过的变量”(Variable defined but never used)。检查一下,确认并不是真正要引用该变量。(RAII基于栈的对象经常会引起此警告的误报,见第13条。)如果确实不需要,经常可以通过插入一个变量本身的求值表达式,使编译器不再报警。(这种求值不会影响运行时的速度。)

// 警告:variable 'lock' is defined but never used
void Fun() {
 Lock lock;
 // ……
}
// 可能消除了警告的新版本
void Fun() {
 Lock lock;
 lock;
 // ……
}```
例4 “变量使用前可能未经初始化”(Variable may be used without being initialized)。初始化变量(见第19条)。

例5 “遗漏了return语句”(Missing return)。有时候编译器会要求每个分支都有return语句,即使控制流可能永远也不会到达函数的结尾(比如:无限循环,throw语句,其他的返回形式等)。这可能是一件好事,因为有时候你仅仅是认为控制不会运行到结尾。例如,没有default情况的switch语句不太适应变化,应该加上执行assert( false ) 的default情况(见第68条和第90条)。

// 警告: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 “有符号数/无符号数不匹配”(signed/unsigned mismatch)。通常没有必要对符号不同的整数进行比较和赋值。应该改变所操作的变量的类型,从而使类型匹配。最坏的情况下,要插入一个显式的强制转换。(其实不管怎么样,编译器都将为你插入一个强制转换,同时还会发出警告,因此还不如显式地先发而制之。)

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

参考文献
[Meyers97] §48[8] ● [Stroustrup94] §2.6.2

时间: 2024-09-25 02:57:11

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

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

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

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

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

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

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

《C++编程规范:101条规则、准则与最佳实践》——第一章组织和策略问题1.1不要拘泥于小节 (又名:了解哪些东西不应该标准化)

第一章组织和策略问题 C++编程规范:101条规则.准则与最佳实践如果人们按照程序员编程的方式修建房屋,那么一只啄木鸟就能毁灭整个文明. --Gerald Weinberg[1] 为了遵从C和C++的伟大传统,我们从0开始编号.首要的指导原则,也就是第0条,阐明了我们认为对编程规范而言最为基本的建议. 接下来,这个导论性部分的其他条款将主要讲述几个精心选择的基本问题,这些问题大多数与代码本身并没有直接关系,它们讨论的是编写坚实代码所必需的工具和技术. 本部分中我们选出的最有价值条款是第0条:"不

机器学习规则:ML工程最佳实践----rules_of_ml section 1【翻译】

作者:黄永刚 机器学习规则:ML工程最佳实践 本文旨在指引具有机器学习基础知识的工程师等人,更好的从机器学习的实践中收益.介绍一些应用机器学习需要遵循的规则,类似于Google C++ 风格指南等流行的编程指南.如果你已经上过机器学习相关课程或者正在从事相关的工作,那你已经满足阅读本文所需的背景知识了. Before Machine Learning Rule: #1: 不要害怕开发没有应用机器学习技术的产品 Rule: #2: 设计评价指标并设立优先级 Rule: #3: 先使用复杂的启发式规

Delphi面向对象编程的20条规则之一

问题描述 前言 大多数Delphi程序员都像使用VisualBasic那样使用他们手头上开发工具,而丝毫没有意识到Delphi的强大功能,更谈不上使用这些功能了.(写到这里,编辑惶恐的举起了手,怎么可能呢?)Delphi和VisualBasic不同,Delphi完全建立在面向对象结构上,这不仅影响到VCL的结构,而且影响到使用Delphi开发的每一个程序. 在本文中,我不想涉及到面向对象编程(OOP)的所有理论,只是提出一些简单的经验规则.希望这些规则能够帮助改善你的程序结构.无论你开发的是何种

《PostgreSQL服务器编程》一一1.8 程序设计最佳实践

1.8 程序设计最佳实践 开发应用程序软件是复杂的.一些有助于管理复杂性的方法非常流行,以至于它们被赋予容易记忆的首字母缩略词.接下来,我们就会介绍一些这样的规则,并介绍如何在服务器程序设计时更好地遵守这些规则.1.8.1 KISS--尽量简单(keep it simple stupid)成功的程序设计的一个重要技术就是编写简单的代码.也就是,你编写的代码3年以后仍然可以很容易理解,并且其他人也可以理解.这种方式并不一定总是行得通,但是尽可能用最简单的方法编写代码总是有意义的.由于各种原因,比如

【译】11条Java异常处理的最佳实践

本文翻译自Top 11 Java Exception Best Practices 在之前关于Java异常的文章中,已经探讨过suppressed exceptions和Java Exceptions Tutorial两个方面的内容.要想在实际项目中正确处理Java异常,你应该熟练掌握一些Java异常处理的最佳实践. Java 异常处理的最佳实践 不要 在catch语句块中压制异常 public class ExceptionExample { public FileInputStream te

《C++编程规范:101条规则、准则与最佳实践》——2.8懂得何时和如何进行并发性编程

2.8懂得何时和如何进行并发性编程 摘要 安线全程地[4]:如果应用程序使用了多个线程或者进程,应该知道如何尽量减少共享对象(见第10条),以及如何安全地共享必须共享的对象. 讨论 线程处理是一个大课题.之所以撰写本条,是因为这个课题很重要,需要明确地予以阐述,但是单凭一个条款显然无法做出公允的评价,所以我们只简单地概述几个要点.更多的细节和具体技术,参阅本条的参考文献.其中最重要的问题是避免死锁.活锁(livelock)[5]和恶性的竞争条件(包括加锁不足导致的崩溃). C++标准关于线程未置