写点什么

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:402435
用户头像

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

关注

评论

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

SAP云平台运行环境Cloud Foundry和Neo的区别

汪子熙

云平台 SAP 11月日更

Code Review&编程习惯,安卓工程师面试题

android 程序员 移动开发

Python爬虫私活,代码公开!采集了20000+漫展历史数据,一言不合就开源

梦想橡皮擦

11月日更

Code Review&编程习惯(1),安卓网络通信开发

android 程序员 移动开发

kubernetes系列随笔02:docker技术原理

Geek_cd6rkj

Docker Kubernetes 容器

DialogFragment探索与实现(1),2021年是做安卓开发人员的绝佳时机

android 程序员 移动开发

BindService的生命周期分析【我读源码你不读,我吃螃蟹你吃土

android 程序员 移动开发

Canvas加动画,实现火柴人跳绳效果,2021Android开发面试解答

android 程序员 移动开发

云小课|大数据时代的隐私利器-GaussDB(DWS)数据脱敏

华为云开发者联盟

EI智能体 DWS数据脱敏 数据仓库服务GaussDB(DWS)

cmake使用教程(三)-安装,程序员去大公司面试

android 程序员 移动开发

Dalvik 和 ART 有什么区别?深扒 Android 虚拟机发展史,真相却出乎意料

android 程序员 移动开发

Dagger2入门系列一:基础使用,从基础到源码统统帮你搞定

android 程序员 移动开发

Android:这是一份全面&详细的-热修复-学习指南,含泪狂刷Android基础面试118题

android 程序员 移动开发

ASM插桩--多线程运行监测,2021Android大厂面试经验分享

android 程序员 移动开发

CountDownLatch 源码分析示例,《Android面试题及解析》分享给大家

android 程序员 移动开发

CAS机制详解,android开发基础知识点

android 程序员 移动开发

王者荣耀商城异地多活架构设计

缘分呐

架构设计

Coroutine 基本原理,吃透这份阿里P8纯手打Android面经

android 程序员 移动开发

AOP与OOP有什么区别,谈谈AOP的原理是什么,腾讯T2大牛亲自讲解

android 程序员 移动开发

BATJ面霸:程序员可是要改变世界呀!阿里巴巴3面(1),flutter下载文件

android 程序员 移动开发

测试用例又双叒叕失败了,NLP帮你来分析

华为云开发者联盟

软件 测试 nlp 测试用例

BottomSheetDialog 使用详解,设置圆角、固定高度,移动开发工程师

android 程序员 移动开发

cmake使用教程(三)-安装(1),kotlin入门项目

android 程序员 移动开发

BAT常见Android面试20题详解,小白看完都会了

android 程序员 移动开发

BindService的生命周期分析【我读源码你不读,我吃螃蟹你吃土(1)

android 程序员 移动开发

cmake使用教程(一)-起步,移动应用开发就业

android 程序员 移动开发

cmake使用教程(九)-关于安卓的交叉编译,腾讯&字节&爱奇艺&网易&华为实习面试汇总

android 程序员 移动开发

Context都没弄明白,还怎么做Android开发?,靠着这份面试题跟答案

android 程序员 移动开发

ARouter源码详解,androidjni开发流程

android 程序员 移动开发

ARouter系列2:源码分析,移动端跨平台开发

android 程序员 移动开发

BATJ面霸:程序员可是要改变世界呀!阿里巴巴3面,移动客户端开发岗面试题

android 程序员 移动开发

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