Как добавить документацию в функцию при сборке пакета NuGet

Question

Я создаю внутренний пакет NuGet для работы и хочу сделать его максимально простым в использовании.

Как включить определения функций и описания для открытых методов в пакет NuGet?

Я собираюсь что-то похожее на это:

Что-то, что я должен добавить в свой пакет, чтобы предоставить те детали того, что делает функция?

Дополнительные баллы за объяснение того, как это сделать с помощью инструмента обозревателя пакетов Nuget.

Answer 1

Этот тип документации добавляется через комментарии к документации XML. Когда вы компилируете с включенной опцией Generate XML Documentation, рядом с вашей DLL создается файл XML, который включает документацию. Вы можете включить это в свой .nuspec файл, чтобы распространить его с вашей библиотекой, и Visual Studio подберет его автоматически.

В ваших функциях просто включите нужные теги в /// блок:

/// <summary>  
///  Returns "Hello World!"  
/// </summary>  
/// <remarks>This function is pretty useless, actually.</remarks>
public string HelloWorld() 

Существует ряд общих и рекомендуемых тегов, которые вы можете использовать. Visual Studio должна быть в состоянии дать вам немного Intellisense по этим вопросам.

При создании пакета включите параметр "Создать документацию XML" и включите созданный файл XML в файл nuspec, как описано в следующем вопросе: Как включить документы Xml для библиотеки классов в пакет NuGet?