C＃のメソッド実装に関するコンパイル時にカスタム警告を表示する

Question

現在のコンテキストでは、開始と停止の2つのメソッドがあります。これらの2つのメソッドは、関数から順番に呼び出されます。ある人が自分のメソッド内でStart（）を呼び出すが、Stop（）を呼び出すことは忘れてしまう可能性があります。例えばこの文脈において

private void A() 
{ 
    Start(); 

    //Buisness logic goes here 

} 

コードは、警告またはエラーをコンパイル時にすべての開始の（））に対応するストップ（が存在すべきである旨が表示される必要があります。誰かがC＃で同じものを実装する方法についてのアイディアを提案できますか？

実装の適切な方法が

private void A() 
{ 
    Start(); 

    //Buisness logic goes here 

    Stop(); 

} 

Answer 1

だろうEVKは、ここでは、良いヒントを与えた私は、より詳細にそれを行うだろうかです：

1. が実装（例えばStartStop）のクラスを持っていますIDisposable

   public class StartStop : IDisposable 
   { 
       public StartStop() { Start(); } 
   
       public void Dispose() { Stop(); } 
   
       protected void Start() { /*...*/ } 
   
       protected void Stop() { /*...*/ } 
   } 
   

2. で、このクラスをご利用ください：

   private void A() 
   { 
       using(var startStopCaller = new StartStopCaller()) 
       { 
        // Your code here 
       } 
   } 
   

usingDispose()を確認しますと、その後Stop()はハードクラッシュを除いて呼び出されます。

Answer 2

これは、2つの主要な方向で、多くの方法でアプローチすることができます：あなたは.NETプラットフォームのそれ以降のバージョン、およびので、ロザリンコンパイラ（Defaults from VS2015 and onwards）を使用している場合は、あなたがに見ることができます

• これをチェックするコンパイラプラグインを作成します。ここではいくつかのリソースは次のとおりです。
  • Introduction to Scripting with the .NET Compiler Platform (Roslyn)
  • .NET Compiler Platform SDK
  • おそらくよりそこに多く、あなたが「ロスリン」または「.NETコンパイラプラットフォーム」を検索する場合。
• コメントの一部が指摘しているように、これはコードとプログラムデザインで修正される可能性があります。 これはおそらくこれにアプローチする "正しい"方法です。いくつかの例：
  • implementing IDisposableを検討し、using statementであなたのクラスを使用するには - しかし、停止し、オブジェクトを廃棄することはここでは同じではないかもしれないことを覚えておいてください。あなたは、あなたのプログラムの内部の仕組みについての知識を持って、これに関する情報に基づいた意思決定を行うべきです。
  • これらのクラスを他の場所から呼び出す場合は、StartとStopの両方のメソッドを含むインターフェイスを実装できるようにすることができます。そして、呼び出し側のクラスが単にこのインタフェースとして扱うようにし、どちらの実装を使用していても両方のメソッドを呼び出すようにします。
  • Start（）とStop（）を順番に実行しないようにコードを再設計します。これには、プログラムの基本的な設計変更とそれがどのように機能するかが必要になるかもしれませんが、価値があるかもしれません。読みやすさと保守性の両方を考慮しています。

Answer 3

私はあなたがプログラマにそれをさらすことなくStartとStopの世話をするためにあなたのパターンを変更することをお勧め。

ではなく Executeメソッドを実装するに Start & Stopを実装するクラスを変更し、 Start & Stopを公開してもいけない

。

public class MyClass 
{ 
    private void Start(){} // old public method 
    private void Stop(){} // old public method 

    public void Execute(Action action) 
    { 
     Start(); 
     action(); 
     Stop(); 
    } 
} 

使用法：

var impl = new MyClass(); 
impl.Execute(() => { 
    // do something in between start & stop 
});