在编译时显示与 C# 中的方法实现相关的自定义警告

Question

在当前上下文中，我们有两个方法 Start 和 Stop。这两个方法是从一个函数顺序调用的。有可能一个人在他的方法中只调用了 Start() 但忘记调用 Stop()。例如

private void A()
{
  Start();

  //Buisness logic goes here

}

在这种情况下，当编译代码时，需要显示警告或错误，通知每个 Start() 都应该有一个相应的 Stop()。有人可以就如何在 C# 中实现相同的想法提出建议吗？

正确的实现方式是

private void A()
{
  Start();

  //Buisness logic goes here

  Stop();

}

Answer 1

我建议您更改您的模式以处理 Start 和 Stop 而无需将其暴露给程序员。

将实现Start 和Stop 的类更改为实现Execute 方法，甚至不要公开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
});

Answer 2

Evk 给出了一个很好的提示，下面是我将如何更详细地做到这一点：

1. 有一个类（例如 StartStop ）实现IDisposable

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

2. 通过using使用这个类：

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

using 将确保调用Dispose() 和随后的Stop()，除非发生硬崩溃。

Answer 3

这可以通过多种方式实现，主要有两个方向：

• 如果您使用的是 .NET 平台的更高版本，因此使用的是 Roslyn 编译器 (Defaults from VS2015 and onwards)，您可以考虑编写一个编译器插件来为您检查这一点。以下是一些资源：
  • Introduction to Scripting with the .NET Compiler Platform (Roslyn)
  • .NET Compiler Platform SDK
  • 如果您搜索“Roslyn”或“.NET 编译器平台”，可能还有更多。
• 正如您得到的一些 cmets 所指出的，这可以在您的代码和程序设计中修复。 这很可能是解决这个问题的“正确”方法。一些例子：
  • 考虑implementing IDisposable 并在using statement 中使用您的类 - 但是，请记住，此处停止和处置对象可能不同。您应该根据自己对程序内部工作原理的了解做出明智的决定。
  • 如果您从其他地方调用这些类，您可以让它们实现一个包含Start 和Stop 方法的接口。然后让调用类简单地把它们当作这个接口，并确保它调用这两个方法，无论它使用哪个实现。
  • 重新设计您的代码，使其不依赖于顺序运行 Start() 和 Stop()。这可能需要对您的程序及其工作方式进行基本的设计更改，但这可能是值得的。兼顾可读性和可维护性。