Автоматическое создание XML-документации для сгенерированных исключений в C # - PullRequest
2 голосов
/ 15 января 2009

В C # хорошей практикой является добавление XML-документации для описания любых исключений, которые может вызвать метод. Нетрудно добавить их для исключений, которые вы бросаете сами. Однако, если я вызываю другой метод, и я решил не обрабатывать исключение, сгенерированное этим вторым методом, нет смысла переписывать существующую документацию. Мне нужно найти документацию для этого второго метода и скопировать и вставить ее в документацию для моего метода. Хуже всего остаются методы Framework, где я копирую и вставляю небольшие куски текста из MSDN в свою документацию.

Существуют ли инструменты, которые могут автоматизировать этот процесс? Я думаю, что должен быть подключаемый модуль для VS, который позволяет вам щелкнуть правой кнопкой мыши вызываемый метод и выбрать что-то вроде " Добавить документацию исключений в документацию вызывающего метода ". Любые предложения будут полезны.

1 Ответ

2 голосов
/ 15 января 2009

Это звучит как запрос функции для ghostdoc . Он этого не делает, но помогает копировать документацию при переопределении метода или реализации интерфейса.

При этом такая функция будет иметь ограниченную полезность, поскольку в C # нет проверенных исключений , таких как Java.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...