Namespaces
Variants

C attribute: deprecated (since C23)

From cppreference.net

表示使用此属性声明的名称或实体已被 弃用 ,即虽然仍允许使用,但出于某些原因不推荐继续使用。

目录

语法

[[ deprecated ]]
[[ __deprecated__ ]]
(1)
[[ deprecated ( 字符串字面量 ) ]]
[[ __deprecated__ ( 字符串字面量 ) ]]
(2)
string-literal - 可用于说明弃用原因和/或建议替代实体的文本

说明

表示允许使用以此属性声明的名称或实体,但出于某些原因不鼓励使用。编译器通常会对这类使用发出警告。如果指定了 字符串字面量 ,通常会将其包含在警告信息中。

此属性允许在以下名称或实体的声明中使用:

  • 结构体 / 联合体 struct [ [ deprecated ] ] S ;
  • 类型定义名 [ [ deprecated ] ] typedef S * PS ;
  • 对象: [ [ deprecated ] ] int x ;
  • 结构体/联合体成员: union U { [ [ deprecated ] ] int n ; } ;
  • 函数 [ [ deprecated ] ] void f ( void ) ;
  • 枚举 enum [ [ deprecated ] ] E { } ;
  • 枚举项: enum { A [ [ deprecated ] ] , B [ [ deprecated ] ] = 42 } ;

被声明为非弃用的名称可以重新声明为弃用。被声明为弃用的名称无法通过不带此属性的重新声明来取消弃用状态。

示例

#include <stdio.h>
[[deprecated]]
void TriassicPeriod(void)
{
    puts("Triassic Period: [251.9 - 208.5] million years ago.");
}
[[deprecated("Use NeogenePeriod() instead.")]]
void JurassicPeriod(void)
{
    puts("Jurassic Period: [201.3 - 152.1] million years ago.");
}
[[deprecated("Use calcSomethingDifferently(int).")]]
int calcSomething(int x)
{
    return x * 2;
}
int main(void)
{
    TriassicPeriod();
    JurassicPeriod();
}

可能的输出:

Triassic Period: [251.9 - 208.5] million years ago.
Jurassic Period: [201.3 - 152.1] million years ago.
prog.c:23:5: warning: 'TriassicPeriod' is deprecated [-Wdeprecated-declarations]
    TriassicPeriod();
    ^
prog.c:3:3: note: 'TriassicPeriod' has been explicitly marked deprecated here
[[deprecated]]
  ^
prog.c:24:5: warning: 'JurassicPeriod' is deprecated: Use NeogenePeriod() instead. [-Wdeprecated-declarations]
    JurassicPeriod();
    ^
prog.c:9:3: note: 'JurassicPeriod' has been explicitly marked deprecated here
[[deprecated("Use NeogenePeriod() instead.")]]
  ^
2 warnings generated.

参见

C++ 文档 关于 deprecated