本文告诉大家如何在打出的 NuGet 包含代码的注释，这样安装了 NuGet 的小伙伴就可以在 VS 上看到对应的方法和类的注释

在使用 SDK Style 格式，可以使用下面一句话在输出的时候添加 xml 注释文件，在打包 NuGet 添加 xml 注释

<PropertyGroup>
      <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

上面代码在 csproj 中添加

另一个方法是指定 DocumentationFile 的路径

  <PropertyGroup>
    <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
  </PropertyGroup>

当然，上面这个方法需要指定路径

在 NuGet 包里面，按照规则，在对应的 xx.dll 或 xx.exe 存在对应的 xx.xml 文件，那么这个 xx.xml 文件将会被作为库的注释文件被 VS 使用

本文会经常更新，请阅读原文： https://dotnet-campus.github.io//post/Roslyn-%E5%9C%A8-NuGet-%E5%8C%85%E4%B8%AD%E6%94%BE%E6%B3%A8%E9%87%8A-xml-%E6%96%87%E4%BB%B6%E7%9A%84%E6%96%B9%E6%B3%95.html ，以避免陈旧错误知识的误导，同时有更好的阅读体验。

知识共享许可协议 本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。欢迎转载、使用、重新发布，但务必保留文章署名 lindexi （包含链接： https://dotnet-campus.github.io/ ），不得用于商业目的，基于本文修改后的作品务必以相同的许可发布。如有任何疑问，请 与我联系 。

相关文章