写点什么

Sandcastle:生成.NET API 文档的工具

  • 2008-02-04
  • 本文字数:647 字

    阅读完需:约 2 分钟

Sandcastle 是一个微软发布的工具,它通过反射程序集中的源代码以及添加代码中的 XML 注释来创建 MSDN 形式的 API 文档。在 CodePlex 中刚发布了 Sandcastle 的一个新版本。 这个工具的源代码可以在CodePlex 中以微软公开许可协议(Microsoft Public License)下获得。即使某些API 不会公开,为其建立文档也是个非常值得推荐的做法,因为这些文档在总会被其他一些内部开发人员使用。而对于公开的API 来说,这样的文档则更是必不可少的东西了。

Sandcastle 的首次公开露面是在 2006 年,它的开发周期已经超过了 2 年。目前发布的为 CTP 版本,但是“1.0 版”应该会在不久的将来发布。 NDoc 则是另一个生成 API 文档的开源工具,在数年前微软宣布要建立 Sandcastle 项目后,其开发就停止了。其他还有一些在 NDoc 的基础上开发的项目,比如 NDoc 2005 NDoc3 等,但是它们仍处于 alpha 开发阶段。

Sandcastle 能够生成类似 MSDN 一样的文档,就像这个示例中的结果一样。Sandcastle 的主要功能有:

  • 兼容署名或未署名的注释
  • 支持范型以及.NET 2.0 框架
  • 微软内部用它来生成.NET 框架的文档
  • 能够声称 Visual Studio 2005、hana 或 prototype (CHM,HxS)类型的文档

Sandcastle 能够在命令行或 GUI 工具里生成文档,这里可以查阅它的使用指南。Sandcastle 是一个独立的工具,因此它能够与任意Visual Studio 项目一起工作。目前有一些将其与Visual Studio 集成的计划,但是还没有得出最终决定。目前的版本能够同时在32 位和64 位的机器上使用。

查看英文原文: Sandcastle: Generate .NET API Documentation

2008-02-04 19:402510
用户头像

发布了 157 篇内容, 共 57.0 次阅读, 收获喜欢 6 次。

关注

评论

发布
暂无评论
发现更多内容

物联网数据可视化利器:云组态设计器全新升级

inBuilder低代码平台

物联网 云组态

1688 商品详情的 API 接口获取与分析:解锁商业洞察的关键

Noah

如何一键解决离职与出差管理难题?

聚道云软件连接器

案例分享

性能测试介绍

测吧(北京)科技有限公司

测试

不只是前端,后端、产品和测试也需要了解的浏览器知识

京东科技开发者

SD-WAN会替代传统的IPsec VPN吗?

Ogcloud

SD-WAN 企业组网 SD-WAN组网 SD-WAN服务商 SDWAN

数据科学领军者助阵!上海大学携手和鲸科技,打造“课-训-赛”一体化教学新体验

ModelWhale

数据科学 课训赛一体

Web3 游戏周报(6.23 - 6.29)

Footprint Analytics

链游

技术干货丨如何加速工业数字孪生应用落地?

Altair RapidMiner

人工智能 数据分析 数字孪生 altair

万界星空科技铜管加工行业MES系统解决方案

万界星空科技

mes 万界星空科技 铜管加工 铜管加工行业mes

SD-WAN解决跨境电商网络问题

Ogcloud

跨境电商 SD-WAN SD-WAN组网 SD-WAN服务商 跨境电商网络

闲鱼商品详情数据接口(goodfish.item_get)

tbapi

闲鱼API 闲鱼商品详情接口 闲鱼商品详情数据采集

在 KubeSphere 上快速安装和使用 KDP 云原生数据平台

智领云科技

开源 Kubernetes KubeSphere KDP 云原生应用数据平台

百度发布文心大模型4.0 Turbo,多端面向用户正式开放

百度安全

阿里巴巴拍立淘按图搜索商品API返回值分析:图像识别技术助力电商库存管理优化

技术冰糖葫芦

API Explorer API 编排 API 安全 API 文档

Baidu Comate发布中文名“文心快码”,企业级安全能力全面升级

百度安全

hypernetwork在SD中是怎么工作的

程序那些事

程序那些事 Stable Diffusion

AI应用实战营-作业1-提示词

德拉古蒂洛维奇

mac英语学习工具:Eudic欧路词典 for Mac 激活版

你的猪会飞吗

mac破解软件下载

生产环境部署Nginx服务器双机热备部署-keepalived(多种模式教程)

不在线第一只蜗牛

nginx 部署 生产环境

Sandcastle:生成.NET API文档的工具_.NET_Abel Avram_InfoQ精选文章