2007年9月14日金曜日

古いメソッドが使われないように警告を出す

ObsoleteAttribute:メソッドや変数を使うとコンパイル時に警告を出してくれる。

リファクタリングを行った後に、
同じ動きを別の手段を使えば出来るようになったメソッドが出たが、
影響範囲が広いため、変更する時間が無かった。
その事を他の人に言葉で伝えたとしても間違って使うかもしれない。

そこで何かないかな~と探した結果
ObsoleteAttribute という属性を発見した。

この属性を付けておけば、
使って欲しくないメソッドを使ってコンパイルすると警告を出してくれます。
またメッセージも添えれるので、新しいメソッドを使ってもらうように促す事も可能。

めちゃ便利です。

使い方はこんな感じ。
----------
using System;

[ObsoleteAttribute("適当なメッセージ")]
bool function(); // 関数の宣言
----------

もしくは
----------
using System;

// 第二引数をfalseでWarning扱い trueにするとエラーになりコンパイルできなくなります。
[ObsoleteAttribute("適当なメッセージ", false)]
bool function(); // 関数の宣言
----------

#第二引数をtrueにするぐらいなら削除するべきな気もするけど...

.

0 件のコメント:

ラベル