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

Question

我知道，现在已经太晚了，我们之前应该创建所有可能的错误列表。 在我们使用其他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

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

像GhostDoc这样的工具可以帮助您更快地编写这些工具 。

由于你已经在制作中，我会为代码编写一个补丁并将其搁置在源代码控制中。