记录WCF API错误（最佳方式）

Question

我知道，现在已经太晚了，我们之前应该创建所有可能的错误列表。我们无法在bcse之前执行此操作，因为我们使用其他API来为我们的API提供服务，并且第三方API为我们提供了任何错误的德语消息。

现在，我们的一位客户已要求向他们提供可能的错误消息列表，供他们相应处理。

能否请您提供记录错误列表的理想方法。我即将开始使用excel电子表格，但估计应该有更好的方法。

Answer 1

在WCF中，您应该使用FaultException。实际上，您可以从FaultException派生出来，这些将通过网络进行序列化。

通过这种方式，您的服务将正确地将异常传递给消费者可以处理的异常（例如，序列化为SOAP）。

这就是为什么它在那里。但鉴于你正在制作中，你可能没有选择。

Answer 2

您可以使用标准的C＃XML文档语法，解释每种方法可以抛出的内容。请参阅：http://msdn.microsoft.com/en-us/library/b2s063f7(v=VS.100).aspx

然后，您可以使用工具such as Sandcastle展示文档，该工具将吐出MSDN样式的文档。

Tools like GhostDoc可以帮助您更快地写下这些内容。

由于您已经投入生产，我会为代码编写一个补丁并将其搁置在源代码管理中。