1.5 C++17注解标签(attributes)
在C++98/03时代,不同的编译器使用不同的注解为代码增加了一些额外的说明,读者可能在各种C/C++代码中见过#pragma、__declspec、__attribute等注解。然而,不同的编译器对于同一功能可能使用不同的注解,导致我们需要为不同的编译器编写不同的注解代码。从C++11开始,新的语言标准统一制定了一些常用的注解标签,本节介绍一些比较常用的注解标签。使用注解标签的语法如下:
这些标签可用于修饰任意类型、函数或者enumeration,在C++17之前不能用于修饰命名空间(namespace)和enumerator,在C++17标准中,这个限制也被取消了。
1.5.1 C++98/03的enumeration和C++11的enumerator
读者可能对enumeration和enumerator这两个词感到困惑,前者指的是从C时代就存在的不限定作用域的枚举。例如,下面的枚举类型就是一个enumeration:
这种枚举类型之所以被称为不限定作用域的枚举,是因为一旦定义了这样一种枚举,在其所在的作用域内就不能再定义与之同名的变量了。例如,如果定义了上述Color枚举,此时再定义一个名为 white 的变量,就无法编译通过了。而 enumerator 指的是从 C++11开始引入的以如下形式定义的枚举变量:
此时,由于枚举值white对外部不可见(必须通过Color::white引用),所以可以定义一个同名的white变量。这种枚举变量被称为限定作用域的枚举。
1.5.2 C++17的注解标签
在分清楚enumeration和enumerator之后,让我们回到正题上来。
C++11引入的常用注解标签有[[noreturn]],这个注解的含义是告诉编译器某个函数没有返回值,例如:
这个标签一般在设计一些系统函数时使用,例如std::abort()和std::exit()。
C++14 引入了[[deprecated]]标签来表示一个函数或者类型等已被弃用,在使用这些被弃用的函数或者类型并编译时,编译器会给出相应的警告,有的编译器直接生成编译错误:
这个标签在实际开发中非常有用,尤其在设计一些库代码时,如果库作者希望某个函数或者类型不想再被用户使用,则可以使用该标注标记。当然,我们也可以使用如下语法给出编译时的具体警告或者出错信息:
有如下代码:
若在main函数中调用被标记为deprecated的函数funcX,则在gcc/g++7.3中编译时会得到如下警告信息:
Java 开发者对这个标注应该再熟悉不过了。在 Java 中使用@Deprecated 标注可以达到同样的效果,这大概是 C++标准委员“拖欠”广大 C++开发者太久的一个特性吧。
C++17提供了三个实用注解:[[fallthrough]]、[[nodiscard]]和[[maybe_unused]],这里逐一介绍它们的用法。
[[fallthrough]]用于 switch-case 语句中,在某个 case 分支执行完毕后如果没有 break语句,则编译器可能会给出一条警告。但有时这可能是开发者有意为之的。为了让编译器明确知道开发者的意图,可以在需要某个 case分支被“贯穿”的地方(上一个case没有break语句)显式设置[[fallthrough]]标记。代码示例如下:
注意:在gcc/g++中,[[fallthrough]]后面的分号不是必需的,在Visual Studio中必须加上分号,否则无法编译通过。
熟悉Golang的读者,可能对fallthrough这一语法特性非常熟悉,Golang中在switch-case后加上fallthrough,是一个常用的告诉编译器意图的语法规则。代码示例如下。
[[nodiscard]]一般用于修饰函数,告诉函数调用者必须关注该函数的返回值(即不能丢弃该函数的返回值)。如果函数调用者未将该函数的返回值赋值给一个变量,则编译器会给出一个警告。例如,假设有一个网络连接函数 connect,我们通过返回值明确说明了连接是否建立成功,则为了防止调用者在使用时直接将该值丢弃,我们可以将该函数使用[[nodiscard]]标记:
在C++20中,对于诸如operator new()、std::allocate()等库函数均使用了[[nodiscard]]进行标记,以强调必须使用这些函数的返回值。
在通常情况下,编译器会对程序代码中未使用的函数或变量给出警告,另一些编译器干脆不允许通过编译。在C++17之前,程序员为了消除这些未使用的变量带来的编译警告或者错误,要么修改编译器的警告选项设置,要么定义一个类似于UNREFERENCED_PARAMETER的宏来显式调用这些未使用的变量一次,以消除编译警告或错误:
以上代码节选自一个标准 Win32 程序的结构,其中的函数参数 hPrevInstance 和lpCmdLine一般不会被用到,编译器会给出警告。为了消除这类警告,这里定义了一个宏UNREFERENCED_PARAMETER并进行调用,造成这两个参数被使用的假象。
有了[[maybe_unused]]注解之后,我们就再也不需要这类宏来“欺骗”编译器了。以上代码使用该注解后可以修改如下:
读者可以通过C++官网了解C++新标准中更多注解的用法。