MSVC 相当于 __attribute__ ((warn_unused_result))？

Question

我发现 __attribute__ ((warn_unused_result)) 作为鼓励开发人员不要忽略函数返回的错误代码的一种方法非常有用，但我需要它与 MSVC 以及 gcc 和 gcc 一起使用- 兼容的编译器，例如 ICC。 Microsoft Visual Studio C/C++ 编译器是否有等效机制？ （到目前为止，我已经尝试浏览 MSDN，但没有任何运气。）

Answer 1

它是_Check_return_。有关类似注释的示例，请参阅此处和此处了解函数行为。自 MSVC 2012 起就受支持。

示例：

_Check_return_
int my_return_must_be_checked() {
    return 42;
}

Answer 2

###MSVC 2012 及更高版本的更新

非常感谢 @Albert 指出，从 Visual Studio 2012 开始，在使用 SAL 静态代码分析时，MSVC 现在支持注释 _Check_return_。我添加这个答案是为了包含一个可能对其他人有用的跨平台宏：

#if defined(__GNUC__) && (__GNUC__ >= 4)
#define CHECK_RESULT __attribute__ ((warn_unused_result))
#elif defined(_MSC_VER) && (_MSC_VER >= 1700)
#define CHECK_RESULT _Check_return_
#else
#define CHECK_RESULT
#endif

请注意，与 gcc 等不同，(a) MSVC 需要在两者上都进行注释函数的声明和定义，并且 (b) 注释需要位于声明/定义的开头（gcc 允许）。因此，用法通常需要是例如：

// foo.h

CHECK_RESULT int my_function(void); // declaration

// foo.c

CHECK_RESULT int my_function(void)  // definition
{
    return 42;
}

Note also that you'll need the `/analyze` (or `-analyze`) switch if compiling from the command line, or the equivalent if using the Visual Studio IDE. This also tends to slow the build down somewhat.

Answer 3

某些版本的 VisualStudio 附带了一个静态分析工具，该工具过去称为 PREFast (现在简称为“C/C++ 代码分析”）。 PREFast 使用注释来标记代码。其中一个注释 MustCheck 可以满足您的需求。

Answer 4

据我所知，MS 编译器没有等效的编译指示或属性 - 当您以适当的警告级别打开优化器时，您可以获得的唯一“未使用”类型警告是针对变量的。

Answer 5

我认为其他人提到的 SAL 注释是正确的
MSVC 的答案，但我猜有些人会感兴趣
比 MSVC、GCC 和 GCC 兼容编译器更具可移植性，
所以…

首先，GCC 从 3.4 开始仅支持 warn_unused_result。你可以
想要检查 __GNUC__ / __GNUC_MINOR__ 的值而不是
只是检查 __GNUC__ 是否已定义，尽管此时我已经
很难想象有人会使用 3.4 之前的 GCC 版本。

一些编译器支持 GCC 风格的函数属性，并且可能或
可能未定义 __GNUC__ 和朋友：

• Clang（使用 __has_attribute(warn_unused_result) 进行检查），并且
  但基于它的编译器（emscripten、xlc 13+、armclang 等）
  AFAIK 它总是伪装成至少 GCC 4.2，所以你可能
  不需要显式检查。
• Intel 并不总是定义 __GNUC__（请参阅 -no-gcc 标志）。我
  不知道他们什么时候开始支持它（他们的文档是
  严重缺乏），但我知道 16.0+ 是安全的。
• TI 8.0+ 支持
• TI 7.3+ 在传递 --gcc 时支持；
  __TI_GNU_ATTRIBUTE_SUPPORT__ 将在此时定义。
• Oracle Developer Studio 12.6+ 在 C++ 模式下支持它，但不支持
  C。
• PGI 在 C++ 模式下支持它。 AFAICT 它没有记录，所以我不是
  确定它是什么时候添加的（#1650-D），但它肯定存在
  在 17.10+ 中。它在 C 模式下被默默地忽略，希望他们会
  有一天实施它。

此外，C++17 添加了 [[nodiscard]] 属性。对于以下版本
GCC/clang 在 C++17 模式下支持 [[nodiscard]] 您也可以使用
[[gnu::nodiscard]] 在 C++11 及更高模式中，但如果您隐藏
无论如何，它在宏后面我看不出有理由这样做而不是
只需使用 __attribute__((__warn_unused_result__)) 。

放在一起，HEDLEY_WARN_UNUSED_RESULT 宏“https://nemequ.github.io/hedley/” rel="nofollow noreferrer">Hedley 看起来像：

#if defined(__cplusplus) && (__cplusplus >= 201703L)
#  define HEDLEY_WARN_UNUSED_RESULT [[nodiscard]]
#elif \
  HEDLEY_GNUC_HAS_ATTRIBUTE(warn_unused_result,3,4,0) || \
  HEDLEY_INTEL_VERSION_CHECK(16,0,0) || \
  HEDLEY_TI_VERSION_CHECK(8,0,0) || \
  (HEDLEY_TI_VERSION_CHECK(7,3,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \
  (HEDLEY_SUNPRO_VERSION_CHECK(5,15,0) && defined(__cplusplus)) || \
  HEDLEY_PGI_VERSION_CHECK(17,10,0)
#  define HEDLEY_WARN_UNUSED_RESULT __attribute__((__warn_unused_result__))
#elif defined(_Check_return_) /* SAL */
#  define HEDLEY_WARN_UNUSED_RESULT _Check_return_
#else
#  define HEDLEY_WARN_UNUSED_RESULT
#endif

您应该能够删除内部 Hedley 宏，然后
如果你不想使用，复制逻辑不会太麻烦
Hedley（属于公共领域/CC0）。如果您选择这样做，您应该
可能会将您的移植基于存储库中的版本，因为我的版本要少得多
可能会记得让这个答案保持最新
信息。