документирование ошибок WCF API (Лучший способ)

Question

Я знаю, сейчас слишком поздно, и мы должны были создать все возможные списки ошибок раньше.Мы не могли сделать это до того, как мы использовали другой API для сервера нашего API, и этот сторонний API предоставил нам сообщения на немецком языке для любой ошибки.

Теперь один из наших клиентов попросил предоставить им список возможныхсообщения об ошибках для их соответствующей обработки.

Не могли бы вы предоставить мне идеальный способ документировать списки ошибок.Я собирался начать с таблицы Excel, но думаю, что должен быть какой-то лучший способ.

Answer 1

Существует стандартный синтаксис документации C # XML, который вы можете использовать, объясняя, что может генерировать каждый метод. Смотри: http://msdn.microsoft.com/en-us/library/b2s063f7(v=VS.100).aspx

Затем вы можете представить документы с помощью инструмента , такого как Sandcastle , который выложит документацию в стиле MSDN.

Такие инструменты, как GhostDoc , помогут вам быстрее их написать.

Поскольку вы уже работаете, я бы написал патч для кода и отложил его в системе контроля версий.

Answer 2

В WCF вы должны использовать FaultException.Фактически вы наследуете от FaultException, и они будут сериализованы по проводам.

Таким образом, ваша служба будет корректно передавать исключения по проводам (например, сериализованные в SOAP), с которыми могут работать ваши потребители.* Вот почему это там.Но если вы находитесь в производстве, у вас может не быть выбора.