为什么 clang-tidy 建议到处添加 [[nodiscard]] ？

Question

我有一个 C++ 项目，其中

clang-tidy

建议在任何地方添加

[[nodiscard]]

。这是一个好的做法吗？我的理解是，仅当忽略返回值可能对程序致命时才应使用

[[nodiscard]]

。我有一个对象

Car

并且它有一个成员

const unsigned int m_ID

。 getter

unsigned int getID()

应该有

[[nodiscard]]

吗？

clang-tidy 

建议如此。

编辑：

当然，我不想忽略吸气剂。但是
我的观点是，如果每个返回内容的函数都应该有一个

[[nodiscard]]

，那么属性

[[nodiscard]]

无论如何都是多余的。编译器可以简单地检查所有返回某些内容的函数。

Answer 1

此选项显然是 “modernize-use-nodiscard”，因此您可以根据需要停用该选项。

应该注意的是，此选项概述的规则不是C++标准委员会自己用于何时应用

[[nodiscard]]

的规则。 这些规则是：

应添加在：

• 对于现有 API
  • 不使用返回值总是一个“巨大的错误”（例如总是导致资源泄漏）
  • 不使用返回值会带来麻烦，而且很容易发生（不明显表明有问题）
• 对于新的 API（尚未纳入 C++ 标准）
  • 不使用返回值通常是一个错误。

以下情况不宜添加：

• 对于现有 API
  • 不使用返回值是一种可能/常见的编程方式，至少对于某些输入而言
    • 例如对于 realloc()，当新站点[原文如此]为 0 时，它的作用就像 free
  • 不使用返回值没有任何意义，但不会造成伤害，并且通常不是错误（例如，因为程序员想要请求状态更改）。
  • 它是一个 C 函数，因为它们的声明可能不受 C++ 实现的控制

这就是为什么像

operator new

这样的函数是

[[nodiscard]]

，而像

optional::value

这样的函数不是。你的代码有一个小错误和你的代码从根本上被破坏是有区别的。

[[nodiscard]]

，就委员会而言，是后者。

请注意，容器

empty

方法是一种特殊情况。它们似乎符合“不要使用

[[nodiscard]]

”的模式，但是因为 empty 的

name

与

clear

的名称类似，如果不使用

empty

的返回值，赔率很好，您打算打电话给

clear

。

显然，仅从声明中无法得知这一点，因此 Clang-Tidy 无法实现上述规则。

Answer 2

为什么 clang-tidy 建议到处添加 [[nodiscard]] ？

clang-tidy 不建议添加 [[nodiscard]] 到处。检查的文档中描述了建议的情况。

这是一个好的做法吗？

是的，当丢弃结果可能是一个错误时，使用 [[nodiscard]] 是一个很好的做法。这种情况经常发生。

getter unsigned int getID() 应该有 [[nodiscard]] 吗？

您能想象在不使用返回值的情况下调用 getter 的任何用例吗？如果你确定这种情况不存在，那么你应该使用[[nodiscard]]。我认为所描述的示例中不存在这种情况。

我的理解是，只有当忽略返回值对程序来说可能是致命的时才应该使用 [[nodiscard]] 。

这是一个相当保守的理解。如果您不同意，您可以禁用相关检查。

Answer 3

modernize-use-nodiscard 检查器是我添加到 clang-tidy 的检查器。我希望我的团队能够自由地使用 [[nodiscard]] 来捕获人们在打算使用clear() 时意外使用名为empty() 的函数的情况。

因为开发人员的编码如下：

list.empty()

empty() 上 [[nodiscard]] 的存在强制捕获此类错误。一旦你开始沿着这条路走下去，你就会开始看到人们犯错误的其他地方，特别是在 api 发生更改并且现在它返回应该处理的内容的情况下。

任何可以帮助编译器捕获无意行为的东西都是有价值的，因为它可以消除错误。