C# 软件包中的IntelliSense和三重斜杠注释

我已经开发了一个代码库，我花了大量时间对它进行了全面的文档记录

类、方法和属性是使用三斜杠XML（xmldoc）注释的注释

//
///将两个数字相加。
/// 
///第一个数字。
///第二个数字。
///总数。
公共整数相加（整数a、整数b）
{
返回a+b；
}

但是，当我将其编译成DLL文件并从其他项目引用它时，或者将其打包为我引用的NuGet包时，Visual Studio/IntelliSense不会为我的库提供任何文档

---

为什么会这样？我能做些什么？

我不确定它是否能解决您的问题，但您是否尝试过生成xml文档文件。如果它与dll一起打包，则intelliSense可能会拾取它

---

编译器从生成的注释中删除所有注释，因此当通过.DLL直接引用程序集时，IntelliSense无法提供任何文档

通过在项目属性中启用输出“XML文档文件”，编译器除了输出已编译的.dll文件外，还输出.XML文件。

---

使用NuGet生成软件包（使用

dotnet pack-c release

完成）时，如果存在XML文档文件，那么它将包含XML文档文件，因此使用NuGet安装的软件包如果存在，将向IntelliSense提供文档。

谢谢，这将引导我走向正确的方向。文档现在在使用NuGet时可以使用。