c# dll 自动生成 api 文档

最新推荐文章于 2025-04-28 13:51:49 发布
最新推荐文章于 2025-04-28 13:51:49 发布
阅读量1.3k 收藏 5
点赞数 2
CC 4.0 BY-SA版权
分类专栏： 游戏开发 文章标签： unity3d c# 自动生成api
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/ithinking110/article/details/110192355
本文介绍如何使用开源工具 SHFB 自动生成 C# DLL 的 API 文档。步骤包括下载安装 SHFB、配置 DLL 工程生成 XML 文档、创建 SHFB 工程并设置构建选项等。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

c# dll 自动生成 api 文档


在msdn 上 可以看到这样的api 文档 在这里插入图片描述
我们自己的dll 也可以自动生成 。

1，下载工具包

开源免费： https://github.com/EWSoftware/SHFB/releases
下载release 版本一步一步全安装 。

2，生成dll 的工程 要勾上 生成 .xml

在这里插入图片描述

3，用shfb 新建工程

4，添加源 生成的dll 和 xml

在这里插入图片描述

5, build 设置

在这里插入图片描述

6, 勾选自己生成的类

在这里插入图片描述

7， build out 出来 想要的东西

在这里插入图片描述

强大的C#API文档生成工具
07-03
Sandcastle是微软官方的文档生成工具，NDoc开发停止后，这个貌似也是唯一的一个这方面的工具。它从dll文件及其xml注释文件能够生成完整的帮助文档，支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),结合新发布的Sandcastle Help File Builder可视化工具，整个生成过程十分简单，而且SHFB工具看起来很强大，不仅能够直接配置生成文档的各个属性，而且还支持很灵活的扩展设置，为我们提供完美的.NET类库文档成为一个可能。
将C# 类文件中属性和方法自动生成文档，C#类文档结构化生成
12-08
DocFX可以生成静态网页，支持自定义主题，且支持多语言API文档的生成。 四、GhostDoc：快速注释生成插件 GhostDoc是一款Visual Studio插件，它可以自动为类、属性、方法等添加注释，减轻开发者手动编写注释的工作...
C# API 文档自动生成器
qq_44695769的博客
11-29 1173
最近要和别人交际，就要给API文档，但是感觉API文件手动写有点麻烦，想着怎么弄一个自动API文档生成。
C# 中 Assembly 类 API 详解技术文档
lijunhe1991的博客
04-28 689
程序集是.NET 应用程序的基本构建块，是自描述的功能单元，可表现为.dll（类库）或.exe（可执行文件）形式。代码：包含编译后的中间语言（IL）代码，可在运行时由.NET 运行时环境（CLR）执行。元数据：描述程序集中的类型、成员、引用等信息，是反射机制的基础。资源：如图片、文本文件等，可在程序运行时动态加载。功能类别核心 API / 方法典型场景程序集获取插件系统、依赖分析、日志记录、配置管理程序集加载LoadLoadFromLoadFile动态扩展、热更新、代码分析工具、依赖分析工具。
Sandcastle----强大的C#文档生成工具
mituan1234567的专栏
11-05 629
http://www.cnblogs.com/codingsilence/archive/2010/01/14/2146651.html 最近客户索要产品的二次开发类库文档,由于开发过程中并没有考虑过此类文档,而且项目规范比较，持续时间比较长，经手人比较多，还真是麻烦,如果人工制作文档需要是一个比较大的工程.还好有这个文档生成工具,能够根据项目生成文档,而且格式看起来确实很专业.     
为 C# 代码生成 API 文档（自译）
cxu123321的博客
05-29 1737
为 C# 代码生成 API 文档（自译） 原文地址：http://broadcast.oreilly.com/2010/09/build-html-documentation-for-y.html#comments Sandcastle功能概述 如果您使用过的程序集中，带有详细的 API 说明文档，并且文档的格式和 MSDN 上的一样，您将发现这样 API 说明文档的是多么的方便。生成类似的 HTML 格式文档的方法有很多，不过，我发现其中最简单的方法是使用Sandcastle工具来...
c# dll文档生成器
czjnoe的博客
01-14 441
SHFB: Github:https://github.com/EWSoftware/SHFB 1、 2、 3、 4、
C#项目生成API文档
最新发布
07-19
我们正在为C#项目生成API文档寻找工具或方法。根据引用内容，我们可以总结出以下工具： 1. Doxygen（引用[1]）：支持多种语言，包括C#（部分支持）。它可以从源代码注释生成文档，输出格式包括HTML、LaTeX、RTF等。...
C# 使用Aspose生成和修改文档
05-27
本教程将深入探讨如何使用C#结合Aspose库来生成和修改文档。 首先，让我们了解一下Aspose库的核心功能。Aspose库提供了一系列的API，包括Aspose.Words用于处理Word文档，Aspose.Cells用于处理Excel工作簿，Aspose....
C# API文档生成工具SandcastleInstaller介绍
描述中提到的c#生成api文档是指利用Sandcastle Installer安装的工具集，能够为C#编写的程序集（如DLL文件）自动生成API文档。这个过程通常包括提取程序集中的注释和元数据，然后转换成结构化的文档，如HTML，以便...
C#很全API文档
11-24
C#很全API文档
c#API中文说明文档
06-07
c#API中文说明文档visual studio 2012
C#API大全（doc）
10-27
C#API大全，可供初学者参考使用~ 部分内容： 使用C#调用windows API入门（一） 一：入门，直接从 C# 调用 DLL 导出 其实我们的议题应该叫做C#如何直接调用非托管代码，通常有2种方法： 1． 直接调用从 DLL 导出的函数。 2． 调用 COM 对象上的接口方法 我主要讨论从dll中导出函数，基本步骤如下： 1．使用 C# 关键字 static 和 extern 声明方法。 2．将 DllImport 属性附加到该方法。DllImport 属性允许您指定包含该方法的 DLL 的名称。 3．如果需要，为方法的参数和返回值指定自定义封送处理信息，这将重写 .NET Framework 的默认封送处理。 好，我们开始 1．首先我们查询MSDN找到GetShortPathName的定义 The GetShortPathName function retrieves the short path form of the specified path. DWORD GetShortPathName( LPCTSTR lpszLongPath, LPTSTR lpszShortPath, DWORD cchBuffer );
c# api帮助文档
04-15
附：excel文件，查询软件，txt文件 三个！方便需要用API 的用副使用！如:[DllImport("user32.dll", EntryPoint="DdeAbandonTransaction")] public static extern int DdeAbandonTransaction ( int idInst, int hConv, int idTransaction );
C#API官方手册下载
03-12
C#官方文档，深有用处
C#文件操作API手册
01-22
本电子书来自于msdn的api手册的一部分，单独下载以供离线阅读。更多内容请参见：https://docs.microsoft.com/en-us/dotnet/api/
C# API 官方参考文档
十三阿哥的博客
09-26 2062
0、微软官方技术文档：https://learn.microsoft.com/zh-cn/docs/ 1、.NET 文档：https://learn.microsoft.com/zh-cn/dotnet/ 2、.NET 语法及相关属性学习：https://learn.microsoft.com/zh-cn/dotnet/csharp/language-reference/ 3、.NET API在线手册：https://learn.microsoft.com/zh-cn/dotnet/api/?view=ne
C# 自动生成代码API文档
weixin_30301449的博客
11-16 1593
暂时没学会正规的转载style临时记录一下 NET中的规范标准注释(一) -- XML注释标签讲解 http://www.cnblogs.com/mq0036/p/3544264.html NET中的规范标准注释(二) -- 创建帮助文档入门篇 http://www.cnblogs.com/mq0036/p/3544268.html 简言之： 1. 设置build参数，使XML可...
SandCastle API文档生成（c# dll）
无所谓的专栏
03-09 864
一、Sandcastle 这个是c#类库方法根据注释生成帮助文档的工具，我们经常会遇到把DLL或者API提供给别人调用的情况，通过在方法中添加注释，然后再用Sandcastle 来自动生成文档给调用者，如下图： 图1：这是Sandcastle Help File Builder软件界面 图2：这是生成的chm文档 还可以直接给出示例代码： 图3：还可以直接生成网页 二、下载安装 下载地址： Help File Builder and Tools v2021.4.9.0最...
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值