如何在NuGet包中为类库包含Xml Docs？

在NuGet包中为类库包含Xml Docs，可以按照以下步骤进行：

首先，确保已经安装了NuGet包管理器。如果没有安装，可以在Visual Studio中使用NuGet包管理器控制台，或者在命令行中使用NuGet命令行工具。
在项目中，创建一个名为<项目名称>.nuspec的XML文件，其中<项目名称>是你的类库项目的名称。
在<项目名称>.nuspec文件中，添加以下内容：

<?xml version="1.0"?><package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
 <metadata>
    <id>$id$</id>
   <version>$version$</version>
   <title>$title$</title>
    <authors>$author$</authors>
    <owners>$author$</owners>
    <licenseUrl>http://LICENSE_URL_HERE_OR_DELETE_THIS_LINE</licenseUrl>
   <projectUrl>http://PROJECT_URL_HERE_OR_DELETE_THIS_LINE</projectUrl>
    <iconUrl>http://ICON_URL_HERE_OR_DELETE_THIS_LINE</iconUrl>
   <requireLicenseAcceptance>false</requireLicenseAcceptance>
   <description>$description$</description>
   <releaseNotes>Summary of changes made in this release of the package.</releaseNotes>
    <copyright>Copyright 2022</copyright>
    <tags>Tag1 Tag2</tags>
   <dependencies>
      <!-- Zero or more dependency elements -->
    </dependencies>
  </metadata>
 <files>
    <file src="bin\Debug\*.dll" target="lib" />
    <file src="bin\Debug\*.pdb" target="lib" />
    <file src="bin\Debug\*.xml" target="lib" />
  </files>
</package>

在<files>元素中，添加以下内容，以包含XML文档：

<file src="bin\Debug\*.xml" target="lib" />

在命令行中，导航到<项目名称>.nuspec文件所在的目录，并运行以下命令：

nuget pack <项目名称>.nuspec

这将生成一个名为<项目名称>.nupkg的NuGet包文件，其中包含了类库的XML文档。
最后，使用以下命令将NuGet包发布到私有或公共NuGet服务器：

nuget push <项目名称>.nupkg -Source https://www.nuget.org/api/v2/package

现在，你已经成功地在NuGet包中为类库包含了XML文档。

相关·内容

VisualStudio 如何在 NuGet 包里面同时包含 DEBUG 和 RELEASE 的库

我在开发的时候需要使用到一些 DEBUG 库进行调试，但是我的库是通过 NuGet 给用户的，如果在 NuGet 里面使用到了 DEBUG 的库那么会让代码的运行效率降低。...于是我就找到一个方法，可以在 NuGet 同时打包调试和发布的包，这样在用户调试的时候就可以使用调试的代码我在一个库写代码，我需要做一点黑科技，让吕毅在调试的时候输出的是林德熙是逗比，但是在他发布的时候却输出吕毅是逗比那么我需要如何做...的方法创建一个 NuGet 包，这是 VisualStudio 2017 的 VisualStudio 使用新项目格式快速打出 Nuget 包功能很好用 ?...xml version="1.0"?...包对应的 id 同时放在 build 文件夹里面，也就是打开 nuget包可以看到 build\id.targets 里面的代码才可以运行，关于这个文件请看代码 <?

2K3 0

一文了解Nuget的使用

创建者：包的作者，创建一个项目，最终生成一个后缀名为.nupkg的文件，里面包含了编译代码DLL、与该代码相关的其他文件以及描述清单如版本等信息。...NuGet 自身负责在 nuget.org 中维护包含 100,000 多个唯一包的中央存储库。这些包每天供数以百万的 .NET/.Net Core 开发人员使用。...打包准备工作，创建一个类库并命名为AA.Nlog。 1.配置包元数据，右键项目-》属性 ?...2.从项目中生成nuget包（.nupkg文件），运行pack命令如下： dotnet pack ? nuget包已经生成了，什么是nupkg文件？.nuspec文件是包含程序包元数据的XML清单。...清单始终包含在包装中。

1.4K1 0

Roslyn 在 NuGet 包中放注释 xml 文件的方法

本文告诉大家如何在打出的 NuGet 包含代码的注释，这样安装了 NuGet 的小伙伴就可以在 VS 上看到对应的方法和类的注释在使用 SDK Style 格式，可以使用下面一句话在输出的时候添加 xml...注释文件，在打包 NuGet 添加 xml 注释 true 上面代码在 csproj 中添加另一个方法是指定 DocumentationFile 的路径 bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml 当然...，上面这个方法需要指定路径在 NuGet 包里面，按照规则，在对应的 xx.dll 或 xx.exe 存在对应的 xx.xml 文件，那么这个 xx.xml 文件将会被作为库的注释文件被 VS 使用

1K1 0

GitHub Actions 自动构建并发布到 NuGet

}} 注意: dotnet pack --configuration Release 可以运行在 .sln 目录，将为所有 sln 包含的类库项目打包 dotnet-campus 为你的 GitHub...xml version="1.0" encoding="utf-8"?...\nuget 开头，因为不在环境变量中 - name: Install Nuget uses: nuget/setup-nuget@v1 with: nuget-version: '5....使用Github Actions构建、发布和部署NuGet软件包_寒冰屋的专栏-CSDN博客 Github 自动构建 Nuget 包 - 林一怂儿 - 博客园 dotnet 配置 github 自动打包上传...Docs 使用Github Packages功能上传nuget包到Github - Agile.Zhou - 博客园 Working with the NuGet registry - GitHub

3501 0

龙芯发布 .NET 6 SDK 6.0.105-ea1 LoongArch64 版本

、libHarfBuzzSharp.so 图形库 (通过龙芯Nuget源下载)；支持 SQLite 本地数据库 (通过龙芯Nuget源下载); 支持 dotnet-sdk 各子模块单独分包安装,安装方法请见....NET6安装说明龙芯Nuget源配置方法: 在龙芯Nuget源上，可以找到一些包含 LoongArch64 架构平台相关文件的 nupkg 包。...LoongArch64版.NET版本发布说明上游社区仓库从 .NET7 已原生支持 LoongArch64 架构，龙芯发布的 LoongArch64 架构 SDK ，分两种版本类型：试用版: 其中安装包名字中包含...由于SkiaSharp中包含平台相关代码，所以引用SkiaSharp的项目需要引用LoongArch版本的nupkg，同时一般还需要引用HarfBuzzSharp包。支持的方法有如下两种。...手动下载，并复制到SDK目录如果需要运行从其它平台（如x64）编译好的项目，则建议到龙芯Nuget源手动下载SkiaSharp和HarfBuzzSharp nupkg包，解压后将so文件复制到SDK目录下

3.3K3 0

.NET周刊【6月第1期 2024-06-02】

文中提供了详细的步骤，包括创建.NET6控制台应用程序，配置appsettings.json，安装必要的NuGet包，以及编写代码用于配置及向LLM API发送请求。...通过集成工具、模式和特殊的 NuGet 包，.NET Aspire 支持分布式应用程序开发，实现了自动配置，简化了部署过程，并内置了服务发现功能。...软件包括多个组成部分如主窗体、上传窗体和FTP操作类，支持添加应用名称、版本号、生成更新文件和上传至FTP。源码可在CSDN下载。客户端应用仍在开发中。...XML Web 服务技术解析：WSDL 与 SOAP 原理、应用案例一览 https://www.cnblogs.com/xiaowange/p/18225328 XML Web服务是基于标准和协议（如...第一种将证书文件包含在源文件中，并直接通过相对路径读取；第二种上传证书至App Service Linux后，系统将证书保存于/var/ssl/文件夹中，可以通过SSH方式查看。

1751 0

.NET Core系列： 2 、project.json 这葫芦里卖的什么药

包，其中包含了一堆系统库的NuGet程序包，包含.netcore的基础运行时和基础类库。...本质上来说，NETStandard.Library 是一个目标最低支持基础类库，这样就可以更好的向前兼容性，在现有的平台出现新的版本时（如.net core 1.1 甚至 2.0）而无需重新发布新的变化...，在nuget管理中也可以看到这是默认的离线包目录，我们需要什么样的包只要把它复制到这个目录，在nuget管理中的程序包源选择离线的源即可。...此文件列为 Visual Studio 中 project.json 的子项。 HellodotnetCore.xproj xml version="1.0" encoding="utf-8"?...这里使用了一种非常棒的算法来确定要加载的源代码目录：如果 global.json 中指定的任何源代码位置包含的文件夹具有与包相同的名称（如 Microsoft.Extensions.Logging），

2K8 0

.NET平台系列5 .NET Core 简介

.NET Core 是由许多项目所组成，除了基本的类库(Core FX) 之外，也包含采用 RyuJIT 编译的运行平台 Core CLR、编译器平台.NET Compiler Platform、采用...CoreFX(.NET Core Libraries) CoreFX主要包含数个公共库，例如 System.Collections, System.IO, System.Xml等。...开源地址：https://github.com/dotnet/corefxlab 3、.NET Core 包管理　　.NET Core 的类库采用 NuGet 包化的架构，应用程序只需要使用 project.json....NET Standard Library 是一个总括型的 NuGet Package，其内包含了这些类库包： Microsoft.DotNet.CoreHost NETStandard.Platform...包含了下列类库包： Microsoft.NETCore.Platforms Microsoft.NETCore.Runtime Microsoft.Win32.Primitives

1.1K2 0

是时候将WPF控件库从.Net Framework升级到.NET Core 3.1

但对各种WPF类库/控件库来说情况又不一样了，为了可以满足更多的用户，让控件库可以同时支持.NET Framework和.NET Core十分重要；而且通常类库对其它组件的依赖较少，升级的风险没那么大。...所以要玩.NET Core的WPF，从类库/控件库开始是一个好的选择。...迁移到 PackageReference NuGet 引用引用了Nuget包的旧.NET Framework项目会将引用的Nuget信息记录在packages.config文件中，例如在示例的项目中...如果是应用程序项目的话还需要WinExe，因为这是个类库项目所以缺少了这一节。...： VisualStudio 使用新项目格式快速打出 Nuget 包 6.

4.3K1 0

ASP.NET Core | 笔记

项目） - jack_Meng - 博客园如何使用新的符号包格式“.snupkg”发布 NuGet 符号包 | Microsoft Docs 让你发布的nuget包支持源代码调试 - czd890...你可以使用符号包 (.snupkg) 来分发这些符号，并改善 NuGet 包的调试体验。请注意，符号包并不是使调试符号可用于库使用者的唯一策略。...nuget pack MyPackage.csproj -Symbols -SymbolPackageFormat snupkg 发布符号包为方便起见，首先使用 NuGet 保存 API 密钥（请参阅发布包...nuget push MyPackage.snupkg 还可以使用以下命令__同时推送主包和符号包__。当前文件夹中必须同时有 .nupkg 和 .snupkg 文件。...备注如果没有发布符号包，请检查是否已将 NuGet.org 源配置为 https://api.nuget.org/v3/index.json。只有 NuGet V3 API 才支持符号包发布。

4.7K2 0

使用自定义XML配置文件在.NET桌面程序中保存设置

本文将详细介绍如何在.NET桌面程序中使用自定义的XML配置文件来保存和读取设置。...除了XML之外，我们还将探讨其他常见的配置文件格式，如JSON、INI和YAML，以及它们的优缺点和相关的NuGet类库。...•相关类库：YamlDotNet 3....System.IO.FileMode.Create)) { xs.Serialize(fs, this); } } } SimpleSetting 类中包含了从...同时，我们还探讨了其他常见的配置文件格式，如 JSON、INI 和 YAML，以及它们的优缺点和相关的 NuGet 类库。希望这篇文章能帮助你找到适合你项目需求的配置文件解决方案！

2361 0

dotnet 在 UOS 国产系统上使用 Xamarin Forms 创建 xaml 界面的 GTK 应用

本文告诉大家如何在 UOS 国产系统上，通过 Xamarin.Forms 使用 XAML 写界面逻辑，构建出 GTK 应用本文将使用特别底层的方法告诉大家如何一步步创建，而不是告诉大家如何在 IDE...nuget 还原里面的 project.assests.json 文件将会包含 fallback 路径，如果拷贝到 Linux 下的系统，也许会看到如下提示 Error MSB4018 The "ResolvePackageAssets...xml version="1.0" encoding="utf-8" ?...但是此时将会发现构建不通过，因为 B 项目，也就是 GTK 项目没有引用足够的 NuGet 包。...给 B 项目添加以下 NuGet 库 OpenTK Xamarin.Forms Xamarin.Forms.Platform.GTK 接着打开 B 项目的 Program.cs 文件，在 Main 方法添加如下代码

2.6K1 0

AvaloniaUI项目离线开发全攻略：IDE安装、模板应用与NuGet私有化部署一站式解决

本文将指导您如何在本地网络环境中成功安装并配置AvaloniaUI所需的工具和模板。 2....2.1 Visual Studio 2022安装由于我个人习惯使用Visual Studio开发，因此首先介绍如何在Visual Studio 2022中安装AvaloniaUI扩展。...私有化部署NuGet服务创建好项目后，程序也是无法正常运行的，默认模板依赖Avalonia UI的一些NuGet包，需要在线安装，可以直接把相关库拷贝到内网，但一个一个拷贝、引用还是很麻烦。...为了方便团队内部成员之间共享和管理NuGet包，您可以考虑部署私有NuGet服务。...总结本文介绍了如何在本地网络环境中成功安装并配置AvaloniaUI所需的开发工具和模板，以及如何部署私有NuGet服务以便团队内部成员之间共享和管理NuGet包。

7991 0

win10 uwp 上传Nuget 让别人用我们的库 Nuget下载打包Nuget上传命令行使用Nuget

当我们的库更新的时候，我们又需要从网上搜索，这样不好，于是我们就用Nuget，Nuget可以让我们把我们做出来的东西发在网上让别人下载，需要搜索名称就可以下载，然后更新会通知本文主要讲我们如何制作一个库上传...https://docs.nuget.org/Create/using-a-gui-to-build-packages，下载后运行我们把Nuget.exe放在Path，当然不知道Path,就放在我们要打包的工程文件夹...我们打包首先 nuget spec ? smms.nuspec 这个可以用文本打开，里面会自动替换里面有 xml version="1.0"?...iconUrl 一个32*32像素的.png文件地址，作为最终在nuget中显示的图标描述、标签、许可地址、项目地址 Dependencies 我们发的依赖其他程序，那就写他，具体怎么我还不知...[.Net] 手把手带你将自己打造的类库丢到 NuGet 上 - 反骨仔（二五仔） - 博客园还可以使用比较快的镜像 NuGet镜像上线试运行 - 博客园团队 - 博客园 ----

9341 0

win10 uwp 上传Nuget 让别人用我们的库

当我们的库更新的时候，我们又需要从网上搜索，这样不好，于是我们就用Nuget，Nuget可以让我们把我们做出来的东西发在网上让别人下载，需要搜索名称就可以下载，然后更新会通知本文主要讲我们如何制作一个库上传...https://docs.nuget.org/Create/using-a-gui-to-build-packages，下载后运行我们把Nuget.exe放在Path，当然不知道Path,就放在我们要打包的工程文件夹...xml version="1.0"?...iconUrl 一个32*32像素的.png文件地址，作为最终在nuget中显示的图标描述、标签、许可地址、项目地址 Dependencies 我们发的依赖其他程序，那就写他，具体怎么我还不知...[.Net] 手把手带你将自己打造的类库丢到 NuGet 上 - 反骨仔（二五仔） - 博客园还可以使用比较快的镜像 NuGet镜像上线试运行 - 博客园团队 - 博客园

5251 0

dotnet 打包 NuGet 的配置属性大全整理

本文整理 dotnet 打包 CBB 组件为 NuGet 包时可以使用的配置的各个属性本文将会持续更新，可以通过搜《dotnet 打包 NuGet 的配置属性大全整理林德熙》找到我主站的博客，避免各个备份地址陈旧的内容误导...系属性 PackageId 包的 Id 属性，这是不区分大小写的包标识符，该标识符在 nuget.org 或包所在的私有的 NuGet 源中必须是唯一的。...> 在 dotnet 里面，代码上的公开成员，如公开的方法公开的属性等，的注释是存放在一个和程序集同名后缀为 XML 的文件里面。...在拥有此 XML 文件，即可让 VisualStudio 等 IDE 可以自动提示引用库的代码注释，方便让开发者了解调用库的各个成员的含义。...进行 NuGet 发布的时候，将注释的 XML 文件带到 NuGet 包里面，可以方便让引用此 NuGet 包的项目获取到库的代码注释 EmbedAllSources 将源代码嵌入到 PDB 文件里面，

1.5K2 0

适用于 .NET 稳定的官方OpenAI库

这个项目通过 NuGet 包的形式发布，使得 .NET 应用程序能够轻松地集成和使用 OpenAI 的各种 AI 模型和功能，如文本生成、图像生成、音频转写等。...类库主要特性命名空间组织：该库按 OpenAI REST API 的功能区域组织成不同的命名空间，每个命名空间包含对应的客户端类。...命名空间组织安装 NuGet 包体验其功能安装OpenAI NuGet包既可以体验OpenAI 的各种 AI 模型和功能，如文本生成、图像生成、音频转写等。...dotnet add package OpenAI以下是在 .NET 应用程序中使用 OpenAI 库的简单概述。...开源地址：https://gitee.com/ysgdaydayup/DotNetGuide/blob/main/docs/DotNet/DotNetProjectPicks.md

1361 0

如何将.NET项目迁移到.NET Core

唯一的限制是，软件中必须包含上述版权和许可提示，后者协议将会除了为用户提供版权许可之外，还有专利许可，并且授权是免费，无排他性的(任何个人和企业都能获得授权)并且永久不可撤销，用户使用.NET Core...，nuget归属包被调整，具体类库在.NET Core哪个版本中被实现也不是很清楚，通过下面两个查询助手，即可解决这些问题。...1、查询命名空间、类库在哪个nuget package包中定义（第一次查询比较慢）地址：https://packagesearch.azurewebsites.net/ 2、查询 NET API 在各版本中实现...目标框架名称列表（命名全小写）地址：https://docs.microsoft.com/zh-cn/nuget/reference/target-frameworks 如何调试多目标框架类库？...地址：https://docs.microsoft.com/zh-cn/nuget/reference/target-frameworks NET Standard/Core项目使用条件判断输出多版本xml

1.8K4 0

将传统 ASP.NET 应用迁移到 .NET Core

2 NuGet 包管理请确保你需要使用的NuGet包支持 .NET Core 或 .NET Standard。...如果不支持，那么你需要研究有没有可以替换的NuGet包，或者你是否能够自己写代码去实现相同的功能。...所以，如果你看到一个包的依赖项里有.NET Standard，这意味着你能够将它安装到你的.NET Core工程中。...Dapper AutoMapper Moq 对于客户端包，比如 jQuery，请不要使用NuGet 将它们安装到.NET Core工程中，参见本文的 “客户端包管理” 章节。...它包含 IPv4, IPv6 以及其他信息。这和传统ASP.NET不太一样，对我们更加有用一些。 ?

4.8K4 1

如何从零开发一个NuGet软件包？

但是，您是否曾经尝试并创建过一个nuget包呢？Nuget软件包比较容易引入到类库中。因此，可以使用NuGet软件包管理器将nuget软件包添加到任何项目中。...Nuget包的剖析 Nuget软件包不仅是dll文件。NuGet包是可移植的，它包含您要放入.Net项目中的所有内容。您可以在其中放置txt文件或png文件。这就是为什么我们称它们为“包裹”。...现在已将其嵌入.nupkg中，但在早期版本的NuGet中只能定义为url。 .nuspec nuspec是关于nuget包的元数据文件。在早期版本中，它曾经用于打包nuget包。...[Content_Types] .xml：这是一个元数据文件，提供了程序包中包含的每个文件扩展名。 lib：软件包的主文件夹。此文件夹包括您的构建输出。...创建你的第一个库每一个开发者都应该知道类库。它们很难移动或用于不同的项目。因为它们的输出是dll文件。在本文中，我不会谈论如何构建库。我将展示如何将它们转换为可移植的nuget包。

1.3K3 0

点击加载更多

扫码

添加站长进交流群

领取专属 10元无门槛券

手把手带您无忧上云