Автоматизация документирования исключений - PullRequest
Новая
       10

Автоматизация документирования исключений

4 голосов
/ 21 января 2010

В нашем решении у нас есть проект, который содержит все исключения.

Все исключения наследуют наше базовое исключение, которое наследуется от ApplicationException.

Наше базовое исключение включает поле для номера исключения.

Я хотел бы запустить скрипт, который создает список с именем исключения, номером и XML-документацией.

Есть идеи, как это сделать?

Ответы [ 2 ]

4 голосов
/ 21 января 2010

Если вы хотите создать список пользовательских исключений в вашем приложении, вы можете использовать XML-комментарии для этой задачи. Смотрите принятый ответ на этот вопрос . Насколько я знаю, комментарии не смогут получить доступ к свойству номера ошибки, но вы можете добавить XML-комментарий к этому свойству и указать там номер ошибки.

2 голосов
/ 21 января 2010

«Сценарий» не сможет это сделать. Вам нужен статический анализатор кода, который отслеживает все вызовы метода и определяет, когда объект, производный от Exception, создается и генерируется. Это становится неприятным, когда код вызывает методы в .NET Framework, у вас нет исходного кода для этого. System.Reflection не помогает, не может отражать код.

В конечном итоге это восходит к тому, почему спецификации исключений являются такой плохой идеей.

Для этого у Redgate был продукт под названием «Охотник за исключениями». Но они отказались от этого, не могли сделать это достаточно надежным. Объявление о прекращении здесь . Не покупайте слишком много акций, обвиняя в этом .NET 4.

...