C#のObsolete属性とは？使い方と警告・エラーの出力方法を解説

C#のObsolete属性とは

メソッドにObsolete属性（廃止属性）を付けると、そのコードがコンパイルされる際に、コンパイラが警告またはエラーメッセージを出力します。

クラスに新しいメソッドを追加した後でも、旧メソッドを残しておきたいケースがあります。このような場合、旧メソッドをObsolete属性でマークし、「旧メソッドの代わりに新メソッドを使用してください」というメッセージを表示させることができます。これにより、旧メソッドの利用者に対して非推奨であることを明確に伝えられます。

Obsolete属性の使用例

以下は、Obsolete属性を使用したサンプルコードです。

using System;

public class Demo {
    [Obsolete("Old Method shouldn't be used! Use New Method instead", true)]

    static void OldMethod() {
        Console.WriteLine("This is the old method!");
    }

    static void NewMethod() {
        Console.WriteLine("This is the new method!");
    }

    public static void Main() {
        OldMethod();
    }
}

実行結果（コンパイルエラー）

Obsolete属性の第2引数にtrueを指定すると、単なる警告ではなくコンパイルエラーとして扱われます。そのため、上記のコードをビルドすると、次のようにコンパイルが失敗します。

Compilation failed: 1 error(s), 0 warnings
error CS0619: `Demo.OldMethod()' is obsolete: `Old Method shouldn't be used! Use New Method instead'

なお、第2引数を省略またはfalseにした場合は、コンパイル自体は成功し、警告メッセージのみが表示されます。移行期間中は警告にとどめ、完全に廃止するタイミングでtrueに切り替えるといった使い分けが一般的です。