一个生成.net api文档的工具sandcastle

最新推荐文章于 2023-03-23 14:52:07 发布
原创 最新推荐文章于 2023-03-23 14:52:07 发布 · 507 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#工具 #文档 #api #.net #网管工具 #oracle

本文介绍了Microsoft的Sandcastle和开源工具NDoc的功能与用途。Sandcastle能够通过反射及XML注释自动生成MSDN风格的API文档；而NDoc则是在.NET环境中用于生成API文档的另一工具。
sandcastle是一个微软发布的工具，它通过反射程序集中的源代码以及添加代码中的xml注释来创建msdn形式的api文档。ndoc则是另一个生成api文档的开源工具，在数年前微软宣布要建立sandcastle项目后，其开发就停止了。其他还有一些在ndoc的基础上开发的项目，比如ndoc 2005和ndoc3等，但是它们仍处于alpha开发阶段。 ・ 把vs.net源代码文件中c# xml注释提取成工程文档 ・ syscheck貌似比冰刃还要厉害的杀马辅助工具 ・ 超级圆周率计算工具，可用来测cpu（慎用，有截.. ・ oracle数据库工具不需要装客户端就可以使用，.. ・ 不靠任何工具全手动教你入侵指定网站 ・ 无赏发放网管工具(boss密码读取.老板模式进入... ・ 无赏发放网管工具(boss密码读取.老板模式进入... ・ 【不用开ie】论坛版主管理51cto论坛的工具 ・ oracle数据库工具不需..
・ 不靠任何工具全手动教..
・ 无赏发放网管工具(boss..
Labber
关注
.Net使用SandCastle生成API文档
chengzhf的专栏
06-05 560
.NET下生成api文档的一个好办法
SharpDoc:SharpDoc是一个文档工具，可以为.NET项目生成HTML文档。
05-21
SharpDoc是一个文档工具，用于为.NET项目生成HTML文档。 可以在找到 该文档系统提供了高质量的文档和完全生成的类API参考。 当前功能是： 从.NET程序集和XML文档文件生成类API参考 使用简单而强大的Razor模板引擎...
ASP.NET WebAPI 接口自测工具（v4.0最新版）
03-29
自己在研究ASP.NET WebAPI的过程中，为了方便自己调试，写了一个自测工具。 可以进行 application/json 协议的访问，也可以进行 application/x-www-form-urlencoded 协议的访问。 为了方便经常调试某个接口，可将 访问地址路径 和 参数写入到XML，后续可以选择。 输出参数如果是json字符串，可格式化，便于查看。（但是技术限制，不能传的字符串太长，否则得自己手动复制粘贴） 鉴于看到我这个旧资源还在经常被朋友下载，特此贴出最新版。 此版本为最新版本，添加了功能：可以在http协议的 header 里添加参数，以方便有 header 传参所需要的用户。 另外添加了个小小的 文件占用程序，修复了json convert网页指向错误的问题，在选择xml里的接口时候，可以对已保存的进行修改。 如有疑问或者建议，欢迎探讨。 PowerBy : http://www.iteming.wang，新浪微博：iteming
NuDoc:.NET 框架语言的文档生成器
07-02
纽多克 NuDoc 是 .NET 框架语言的 API 文档生成器。 NuDoc 使用反射来读取有关程序集中类型的信息。 它还可以从嵌入在源代码中的特殊文档注释中读取编译器生成的 XML 文档文件。 给定一个 .NET 程序集及其匹配的 XML 文档文件，NuDoc 生成： 描述程序集公共 API 的 HTML 文件。 （即，公开可见的类型和成员。 程序集的 XML 文档文件，其中仅包含公共 API 的信息。 NuDoc 在概念上类似于 ，但它生成的 HTML API 参考比 Sandcastle 编译的 HTML 帮助格式简单得多，并且它不会尝试索引和交叉引用整个 .NET 框架。 因此，它会在很短的时间内运行。 另一个区别是 NuDoc 报告格式的目标是可读性和简单性，而不是完整性。 NuDoc 从命令行运行，其设计使其可以轻松集成到自动构建系统中。 也可以看看 许可证（麻省理
强大的C#API文档生成工具
07-03
Sandcastle是微软官方的文档生成工具，NDoc开发停止后，这个貌似也是唯一的一个这方面的工具。它从dll文件及其xml注释文件能够生成完整的帮助文档，支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),结合新发布的Sandcastle Help File Builder可视化工具，整个生成过程十分简单，而且SHFB工具看起来很强大，不仅能够直接配置生成文档的各个属性，而且还支持很灵活的扩展设置，为我们提供完美的.NET类库文档成为一个可能。
.net中声明API的工具
weixin_30670965的博客
07-29 184
http://www.pinvoke.net/ 转载于:https://www.cnblogs.com/jessenee/archive/2008/08/14/1267928.html
Sandcastle：生成.NET API文档的工具 (帮忙文档)
08-02 210
(1)准备软件 首先需要我们准备如下软件: SandCastle, 下载地址: http://sandcastle.codeplex.com/releases/view/47665 (2)准备项目文件 准备好程序的dll文件和注释的xml文件.比如本文实例的两个文件:XmlCommentClassDemo.dll 和 XmlCommentClassDemo.XML 注意如果我们...
NDoc - 自动生成.NET类库API文档工具介绍
NDoc是一个曾经在.NET社区广泛使用的文档生成器，它支持多种文档格式的生成，使得.NET项目文档的创建变得简单快捷。然而，考虑到它的维护状态和一些限制，开发者在选择文档生成器时，可能需要考虑其他更为现代的工具...
Sandcastle工具实现高效.Net文档自动生成
Sandcastle是一个开源的.NET文档生成工具，它能够从代码注释中自动生成详细的API文档。这个工具最大的特色在于它能够处理XML注释标签，并且可以生成MSDN风格的文档。此外，Sandcastle还支持多种输出格式，包括CHM...
NDoc 1.3.1中文版：C# .NET XML文档生成工具
从标签列表来看，“C#”、“.NET”、“XML”、“文档生成”、“API文档”、“开发工具”等关键词精准地概括了 NDoc 的技术背景与应用场景。作为一款面向 .NET 平台的工具，NDoc 完全兼容 .NET Framework 1.1 至 2.0 ...
webapi文档生成,快速生成WebApi说明文档
10-16
webapi文档生成,简单配置生成WebApi说明文档,可更新文档，查询文档，模拟请求。方便大家快速方便的生成WebApi说明文档
.NET文档生成工具
weixin_34367845的博客
07-13 171
.NET文档生成工具ADB 使用教程:http://www.cr173.com/html/15960_1.html NDoc v1.3.1(.NET 文档生成器) 下载地址:http://down.chinaz.com/soft/14401.htm
.NET文档工具 NDoc
weixin_34259559的博客
01-23 161
2019独角兽企业重金招聘Python工程师标准>>> ...
.net中的自动文档生成工具
weixin_30546189的博客
08-04 210
由于项目的原因，我需要使用C#编程，以前使用JAVA的时候，就觉得javadoc是非常方便的功能，C#里面也添加了对xml格式的注释的支持，我想当然的觉得Visul Studio里面也会带有类似javadoc那样的工具简简单单就可以生成不差于javadoc的文档。 实际上，我大错特错了。我用的是VS2005，里面根本就没有找到类似的选项，最多只能生成一个xml格式的注释提取文件，但是大家都知道...
自动生成Api文档工具Swagger
s_xchenzejian的博客
07-19 407
参考文章： https://symonlin.github.io/2019/02/02/springboot-3/ https://blog.csdn.net/u012373815/article/details/82685962（较详细，两篇都记得修改apis为你的controller目录）
推荐两个今天发现的文档生成工具
01-18 1701
    相信高手们早已对这些工具很熟悉了，向更多新手推荐一下： C++注释文档生成工具：Doxygen    下载地址：http://www.vckbase.com/code/softeng/engineering/doxygen.rar    源码位置：http://down1.chinaunix.net//distfiles/doxygen-1.4.7.src.tar.gzJavaScri
.NET Core 的 Swagger 接口文档使用教程
polsnet的专栏
03-23 1197
为了让客户端应用程序更容易地理解和使用 Web API，我们需要提供一种描述 Web API 的文档，这就是 Swagger（或 OpenAPI）的作用。Swagger 规范是一个 JSON 格式的文档，它定义了 API 的基本信息、路径、操作、参数、响应和模式等内容。Swagger UI 是一个基于 Web 的工具，它可以根据 Swagger 规范生成一个可视化和交互式的界面，让用户可以浏览和测试 API。它可以让计算机和人类在不直接访问源代码的情况下，理解 REST API 的功能和参数。
接口文档生成工具apipost
sik123的博客
05-16 219
一、为什么要写接口文档？ 1.正规的团队合作或者是项目对接，接口文档是非常重要的，一般接口文档都是通过开发人员写的。一个工整的文档显得是非重要。 2.项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发，项目维护中或者项目人员更迭，方便后期人员查看、维护 二、接口文档的格式 接口主要分为四部分：方法、uri、请求参数、返回参数 三、接口文档生成工具 apipost一款很不错的接口测试工具，它可以生成各种格式的接口文档，有在线版的，markdown格式和word格式的接口文档。 点
.Net十种必备工具
tanliyoung的专栏
09-20 1122
 .NET Tools... 每个.NET 开发人员应该下载的十个必备工具 原著：James Avery 编译：NorthTibet原文出处：.NET Tools：Ten Must-Have Tools Every Developer Should Download Now 本文自发布以来已经增加了新
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值