Страницы

Поиск по вопросам

вторник, 12 февраля 2019 г.

Документация (summary) во внешнем файле

Имеется библиотека. В ней методы, поля (свойства), которые хорошо бы описать, чтобы при использовании Visual Studio высвечивала описание и подсказки для того или иного поля/метода.
Я знаю, что можно писать

прямо в коде и в свойствах сборки добавить галочку для создания XML-документации.
Но если я сейчас прямо в коде начну писать описание, то код заметно удлинится. Можно ли как-то в отдельном файле написать эту документацию?
Чтобы в коде не было , но IntelliSense смог отображать эту информацию?


Ответ

Да, это возможно. Используйте тег include. Теперь достаточно
Аннотировать нужный метод так:
/// public void MethodName(string arg) { } Создать файл external_summary.xml, имеющий такую структуру:

Описание метода Описание параметра arg
В результате после компиляции сборки с опцией /doc вы получите следующую xml-документацию:
Application Описание метода Описание параметра arg

Комментариев нет:

Отправить комментарий