IntelliSense и комментарии с тройной косой чертой в пакетах

Question

Я разработал библиотеку кода, которую я тщательно документировал.

Классы, методы и свойства комментируются с использованием тройного слэша XML (xmldoc) комментариев.

/// <summary>
/// Adds two numbers together.
/// </summary>
/// <param name="a">The first number.</param>
/// <param name="b">The second number.</param>
/// <returns>The sum.</returns>
public int Add(int a, int b)
{
    return a + b;
}

Но когда я компилирую это в файл DLL и ссылаюсь на него из моего другого проекта, или упаковываю как пакет NuGet, на который я ссылаюсь, то Visual Studio / IntelliSense не предоставляет никакой документации для моей библиотеки.

Почему это так, и что я могу с этим поделать?

Answer 1

Я не уверен на 100%, решит ли это вашу проблему, но вы пытались сгенерировать XML-файл документа? если это упаковано с dll, это может быть забрано intelliSense.

Answer 2

Компилятор удаляет все комментарии из полученных комментариев, поэтому при прямой ссылке на сборку по ее.DLL IntelliSense не может предоставить какую-либо документацию.

Включив возможность вывода "файла документации XML" в свойствах проекта, компилятор выводит файл.xml в дополнение к скомпилированному файлу.dll. При использовании NuGet для создания пакета (сделано с помощью dotnet pack -c release) затем он включает файл документации XML, если таковой имеется, следовательно, пакеты, установленные с использованием NuGet, предоставляют документацию IntelliSense, если таковой имеется.