C++ attribute: deprecated (since C++14)

この属性で宣言された名前またはエンティティが deprecated （非推奨）であることを示します。つまり、使用は許可されていますが、何らかの理由で推奨されていません。

構文

説明

この属性で宣言された名前またはエンティティの使用は許可されているが、何らかの理由で推奨されないことを示します。コンパイラは通常、そのような使用に対して警告を発します。 string-literal が指定されている場合、通常は警告に含まれます。

この属性は以下の名前またはエンティティの宣言で使用できます：

• class/struct/union 、例： struct [ [ deprecated ] ] S ; 、
• typedef-name 、 alias declaration によって宣言されたものを含む、例：

• [ [ deprecated ] ] typedef S * PS ; 、
• using PS [ [ deprecated ] ] = S * ; 、

• （非メンバー）変数、例： [ [ deprecated ] ] int x ; 、
• 静的データメンバー 、例： struct S { [ [ deprecated ] ] static constexpr char CR { 13 } ; } ; 、
• 非静的データメンバー 、例： union U { [ [ deprecated ] ] int n ; } ; 、
• 関数 、例： [ [ deprecated ] ] void f ( ) ; 、
• 名前空間 、例： namespace [ [ deprecated ] ] NS { int x ; } 、
• 列挙型 、例： enum [ [ deprecated ] ] E { } ; 、

• テンプレート特殊化 、例: template <> struct [ [ deprecated ] ] X < int > { } ; 。

非推奨として宣言されていない名前は、後で非推奨として再宣言することができます。非推奨として宣言された名前は、この属性なしで再宣言しても非推奨状態を解除することはできません。

例

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

Triassic Period: [251.9 - 208.5] million years ago.
Jurassic Period: [201.3 - 152.1] million years ago.
main.cpp:20:5: warning: 'TriassicPeriod' is deprecated [-Wdeprecated-declarations]
    TriassicPeriod();
    ^
main.cpp:3:3: note: 'TriassicPeriod' has been explicitly marked deprecated here
[[deprecated]]
  ^
main.cpp:21:5: warning: 'JurassicPeriod' is deprecated: Use NeogenePeriod() instead ⮠
 [-Wdeprecated-declarations]
    JurassicPeriod();
    ^
main.cpp:8:3: note: 'JurassicPeriod' has been explicitly marked deprecated here
[[deprecated("Use NeogenePeriod() instead")]]
  ^
2 warnings generated.

参考文献

関連項目