c# - 记录异常

Question

我有以下公共(public)接口(interface)

public interface Bar{
   public void DoStuff();
}

有一个内部后端类

internal class BarImpl : Bar{
   public void DoStuff(){
     // throw exception if invalid state
     // do something
   }
}

问题:

• 只有BarImpl 实现了Bar 接口(interface)。
• BarImpl 可以在 DoStuff 方法中抛出异常。

在 Bar.DoStuff xml 文档中记录这些异常是否有意义？

提前致谢

Answer 1

是的 - 即使 BarImpl 不是唯一的实现者也是如此。

我喜欢使用的示例是 Stream摘要所在的类Read方法列出了 Stream 实例的用户在使用此方法时可能会抛出的所有异常，反过来，此类的实现者应该在各种情况下抛出。