Как добавить справочную документацию по методу в C# dll?
Я хочу добавить справку / документацию к библиотеке, которую я создаю в C#. Я использую /// для создания тегов, и это прекрасно работает, когда я использую методы моей библиотеки в моем проекте библиотеки. Например:
если в моей библиотеке 2 класса Car и Person, если я ввожу Person
Car.StartEngi
автозаполнение VS предложит использовать методы StartEngine, и я увижу сводку, что для метода, например, "Этот метод запустит двигатель автомобиля".
Но проблема возникает, когда я компилирую и пытаюсь ссылаться на DLL на отдельном решении. В новом решении я уже добавил соответствующую ссылку и использование оператора, но когда я пишу
Car.StartEngi
VS действительно порекомендует использовать StartEngine, НО я не вижу документации. Кто-нибудь знает почему? Нужно ли добавлять какой-либо параметр при сборке библиотеки?
PD Все методы в библиотеке, которая генерирует DLL являются открытыми
1 ответ
На странице Build настроек вашего проекта вам нужно включить "XML документацию". Если вы скопируете файл документации XML вместе со своей сборкой, вы сможете увидеть документацию в других проектах.