C++ 属性: nodiscard (自 C++17 起)
来自 cppreference.cn
< cpp | language | attributes
如果从一个丢弃值表达式(除了转换为 void 的转型以外)调用声明为 nodiscard
的函数,或调用返回声明为 nodiscard
的枚举或类的函数,则鼓励编译器发出警告。
目录 |
[编辑] 语法
[[nodiscard]]
|
(1) | (自 C++17 起) | |||||||
[[nodiscard( 字符串字面量 )]] |
(2) | (自 C++20 起) | |||||||
字符串字面量 | - | 一个未求值的字符串字面量,可用于解释为何结果不应被丢弃的理由 |
[编辑] 解释
出现于函数声明、枚举声明或类声明中。
若从一个丢弃值表达式(除了转换为 void 的转型以外),
- 调用了声明为
nodiscard
的函数,或 - 调用了返回声明为
nodiscard
的枚举或类的函数,或 - 通过显式类型转换或static_cast调用了声明为
nodiscard
的构造函数,或 - 通过显式类型转换或static_cast初始化了声明为
nodiscard
的枚举或类类型的对象,
则鼓励编译器发出警告。
若指定了 字符串字面量,则通常将其包含在警告中。 |
(自 C++20 起) |
[编辑] 示例
运行此代码
struct [[nodiscard]] error_info { /*...*/ }; error_info enable_missile_safety_mode() { /*...*/ return {}; } void launch_missiles() { /*...*/ } void test_missiles() { enable_missile_safety_mode(); // compiler may warn on discarding a nodiscard value launch_missiles(); } error_info& foo() { static error_info e; /*...*/ return e; } void f1() { foo(); } // nodiscard type is not returned by value, no warning // nodiscard( string-literal ) (since C++20): [[nodiscard("PURE FUN")]] int strategic_value(int x, int y) { return x ^ y; } int main() { strategic_value(4, 2); // compiler may warn on discarding a nodiscard value auto z = strategic_value(0, 0); // OK: return value is not discarded return z; }
可能的输出
game.cpp:5:4: warning: ignoring return value of function declared with ⮠ 'nodiscard' attribute game.cpp:17:5: warning: ignoring return value of function declared with ⮠ 'nodiscard' attribute: PURE FUN
标准库下列标准函数以
|
(直至 C++26) |
[编辑] 缺陷报告
下列行为变更缺陷报告被追溯应用于先前发布的 C++ 标准。
DR | 应用于 | 发布时的行为 | 正确行为 |
---|---|---|---|
P1771R1 | C++17 | 构造函数上的 [[nodiscard]] 无效 |
若构造的对象被丢弃,则可能导致警告 |
[编辑] 参考
- C++23 标准 (ISO/IEC 14882:2024)
- 9.12.9 Nodiscard 属性 [dcl.attr.nodiscard]
- C++20 标准 (ISO/IEC 14882:2020)
- 9.12.8 Nodiscard 属性 [dcl.attr.nodiscard]
- C++17 标准 (ISO/IEC 14882:2017)
- 10.6.7 Nodiscard 属性 [dcl.attr.nodiscard]
[编辑] 参见
(C++11) |
在使用 tie 解包 tuple 时跳过元素的占位符(常量) |
C 文档 关于 nodiscard
|