C++小知识:尽可能使用枚举类

静态代码分析工具可简化编码过程，检测出错误并帮助修复。PVS-Studio 是一个用于 C/C++ 的静态代码分析工具。该团队检测了 200 多个 C/C++ 开源项目，包括了 Unreal Engine、Php、Haiku、Qt 和 Linux 内核等知名项目。

下面这个 Bug 是在 Source SDK 的源代码中发现的。

错误代码：

这种错误的例子代码量都非常大，我尽可能地选取其中最小的一部分，但是很抱歉，代码看起来依旧很冗长。

enum PhysGunPickup_t
{
 PICKED_UP_BY_CANNON,
 PUNTED_BY_CANNON,
 PICKED_UP_BY_PLAYER,
};
enum PhysGunDrop_t
{
 DROPPED_BY_PLAYER,
 THROWN_BY_PLAYER,
 DROPPED_BY_CANNON,
 LAUNCHED_BY_CANNON,
};
void CBreakableProp::OnPhysGunDrop(...., PhysGunDrop_t Reason)
{
 ....
 if( Reason == PUNTED_BY_CANNON )
 {
  PlayPuntSound();
 }
 ....
}

解释：

Reason 变量是属于枚举类型 PhysGunDrop_t，却用它和属于另一个枚举类型的常量作比较，这种比较显然是个逻辑错误。

但是这种 bug 模式很普遍，我甚至在像 Clang、TortoiseGit 和 Linux Kernel 这种项目中都有碰到过。

为什么会如此频繁？因为在标准C++中，枚举类型本来就不是类型安全的。到底什么该跟什么做比较，很容易让人混淆。

正确代码：

我不太确定这段代码的正确版本应该是什么样的，我猜想 PUNTED_BY_CANNON 应该用 DROPPED_BY_CANNON 或者 LAUNCHED_BY_CANNON 来替代。此处就用 LAUNCHED_BY_CANNON 来代替了。

if( Reason == LAUNCHED_BY_CANNON )
{
 PlayPuntSound();
}

建议：

如果你是用C++写代码，还没碰到过这种bug，算你幸运；我强烈建议你从现在开始在代码中使用“枚举类”。

对于C++11中的一些新特性，我没有太多信心。就拿auto关键字来说吧，我相信如果频繁使用的话，会有很多坏处的。 我是这么看的：比起写代码，程序员会花更多的时间阅读代码，所以我们必须确保程序的可读性很强。 C语言中， 所有变量都必须在函数的一开始就声明，那么在函数的中间或者末尾编辑代码时，没那么容易推测出某个Alice变量到底是什么意思。这也是为什么变量的命名规范会这么多样化？ 例如，前缀命名法PfAlice就代表指向浮点数的指针。

C++中你可以随时随地声明变量，这是一种很好的编码风格。因而使用前后缀命名也不再那么受欢迎了。接着auto关键字出现了，直接导致程序员又开始使用各种各样很难理解的构造形式， 诸如auto Alice= FOO(); 之类的。 Alice？谁是TM的Alice？（为保留原文本意，此处翻译稍有不文明）

很抱歉，又偏离我们的主题了。 我想告诉大家的是一些新的特性都有它的好坏两面性。 但是对于“枚举类”， 我坚信使用它有百利而无一害。

在使用枚举类的时候，必须明确指出指定的常量属于哪个枚举类型，以免在代码中出现错误。使用枚举类更新后的代码如下：

enum class PhysGunDrop_t
{
 DROPPED_BY_PLAYER,
 THROWN_BY_PLAYER,
 DROPPED_BY_CANNON,
 LAUNCHED_BY_CANNON,
};
void CBreakableProp::OnPhysGunDrop(...., PhysGunDrop_t Reason)
{
 ....
 if( Reason == PhysGunDrop_t::LAUNCHED_BY_CANNON )
 {
  PlayPuntSound();
 }
 ....
}

说真的，修复旧代码的确会有一定困难，但我强烈推荐你们在代码中使用枚举类，你的项目定会从中受益。

我觉得在这儿详细介绍枚举类没有多大意义，有兴趣的可以自己去了解一下的。

这个错误是用静态代码分析工具 PVS-Studio 检测到的，错误信息为：V556 对不同枚举类型的值进行比较：Reason == PUNTED_BY_CANNON。

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，谢谢大家对我们的支持。如果你想了解更多相关内容请查看下面相关链接

赞 (0)

相关推荐

  • C++小知识:用合适的工具来分析你的代码

    静态代码分析工具可简化编码过程,检测出错误并帮助修复.有个国外团队检测了 200 多个 C/C++ 开源项目,包括了 Php.Qt 和 Linux 内核等知名项目.于是他们每天分享一个错误案例,并给出相应建议.今天的案例来自 LibreOffice 项目. 错误代码 BOOL WINAPI DllMain( HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved ) { .... CreateThread( NULL, 0, ParentM

  • C++实践分数类中运算符重载的方法参考

    [项目-分数类中的运算符重载] (1)实现分数类中的运算符重载,在分数类中可以完成分数的加减乘除(运算后再化简).比较(6种关系)的运算. class CFraction { private: int nume; // 分子 int deno; // 分母 public: //构造函数及运算符重载的函数声明 }; //重载函数的实现及用于测试的main()函数 (2)在(1)的基础上,实现分数类中的对象和整型数的四则运算.分数类中的对象可以和整型数进行四则运算,且运算符合交换律.例如:CFrac

  • C++小知识:大于0并不意味着等于1

    注:本文所指出的错误例子其实非常简单,任何 C++ 的初学者都能看懂.但是这个错误也非常典型,估计很多非常严肃的代码里面都存在这样的错误. 这个 Bug 是来自于 CoreCLR 源代码. 错误代码: bool operator( )(const GUID& _Key1, const GUID& _Key2) const { return memcmp(&_Key1, &_Key2, sizeof(GUID)) == -1; } 解释: 你不能将 memcpy().strc

  • Python使用ctypes调用C/C++的方法

    python使用ctypes调用C/C++ 1. ctpes介绍 ctypes is a foreign function library for Python. It provides C compatible data types, and allows calling functions in DLLs or shared libraries. It can be used to wrap these libraries in pure Python. 官方文档地址: https://do

  • 剑指offer之C++语言实现链表(两种删除节点方式)

    1 问题 用C++语言实现链表 2 代码实现 #include <iostream> #include <stdlib.h> using namespace std; class List { public: List(); ~List(); List* createNode(int value);//创建节点 bool insertNode(List *node);//插入节点 void printList();//打印节点 bool deleteNode(List *node)

  • C++小知识:不要去做编译器的工作

    对于C++编程的老鸟来说,有时候他们喜欢把一些东西按照编译器的工作原理进行改写,以便提高代码的运行效率.这么做确实高明,也能体现出程序员的水平,但是这么做也是有风险的.因为有时候你可能会因为一些简单的笔误,而造成非常难以察觉的错误.本文就给出了类似的例子. 这个Bug 出现在MySQL源代码中. 错误代码: static int rr_cmp(uchar *a,uchar *b) { if (a[0] != b[0]) return (int) a[0] - (int) b[0]; if (a[

  • C++二维数组中数组元素存储地址的计算疑问讲解

    C++二维数组中数组元素存储地址的计算疑问讲解

    关于二维数组中数组元素的存储地址,有同学问出了个好问题. 在我的课件中,出现了下面的讲解: a[i][j]的地址是p+(i*col+j)*d(d是数组元素所占的字节数). 同学编程序进行验证,出问题了: 地球停止转动了也必须先赞这种学习方式! 同学问:"老师,第一张图的4,我怎么觉得不对呢?第二张图我没4,结果好像也对,这里面差在哪呢?" 我的答复:"两个都对." 第一张图在讲原理,是我们在人脑里面要以"字节"为单位计算,p为首地址,单位是字节,

  • Android Java调用自己C++类库的实例讲解

    Android Java 如何调用自己的 C++ 的类库 下面以 Java 调用 C++ 的加法运算函数为例,做简单说明. (使用 Android Studio 3 编译) 首先编译 c++ 类库 创建独立目录存放 c++ 文件,例如 "app/src/main/cpp/add.cpp",内容如下 #include <jni.h> extern "C" JNIEXPORT jint JNICALL Java_com_example_liyi_demo_U

  • C++小知识:用++i替代i++

    静态代码分析工具可简化编码过程,检测出错误并帮助修复.PVS-Studio 是一个用于 C/C++ 的静态代码分析工具.该团队检测了 200 多个 C/C++ 开源项目,包括了 Unreal Engine.Php.Haiku.Qt 和 Linux 内核等知名项目.于是他们每天分享一个错误案例,并给出相应建议. 这个 bug 是在 Unreal Engine 4 的源代码中发现的. 错误代码: void FSlateNotificationManager::GetWindows( TArray<

  • C++实践排序函数模板项目的参考方法

    [项目-排序函数模板] 已知 void Sort(int a[],int size); void Sort(double a[],int size); 是一个函数模板的两个实例,其功能是将数组a中的前size个元素按从小到大顺序排列.试设计这个函数模板. 参考解答: #include<iostream> using namespace std; template<class T> void Sort(T set[],int n) { int i,j; T temp; for(i=1

随机推荐