写点什么

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

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

关注

评论

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

Spring Cloud Alibaba 应用如何平滑迁移至 IPv6?

阿里巴巴云原生

阿里云 云原生 Spring Cloud Aliababa

想拿到10k-40k的offer,这些技能必不可少!作为程序员的你了解吗

Java你猿哥

Java 面试 架构师 面经 Java工程师

SSD 存储领域厂商大普微加入龙蜥社区,完成与龙蜥操作系统适配

OpenAnolis小助手

开源 操作系统 龙蜥社区 CLA 大普微

PyTorch深度学习实战 | 预测工资——线性回归

TiAmo

深度学习 线性回归 PyTorch 梯度下降法

Activity登堂入室

芯动大师

windows Activity View

极客时间运维进阶训练营第十九周作业

忙着长大#

我没能实现始终在一个线程上运行 task

newbe36524

C#

「硬核实操」如何拥有一个自己的数字人模型

京东科技开发者

京东云 数字人 企业号 4 月 PK 榜

前端里那些你不知道的事儿之 【window.onload】

京东科技开发者

前端 京东云 京东技术 京东科技 企业号 4 月 PK 榜

Go flag 标准库源码解读

江湖十年

后端 命令行 Go 语言

极客时间运维进阶训练营第二十周作业

忙着长大#

5 分钟读懂开源服务框架 Dubbo 及其最新规划

阿里巴巴云原生

阿里云 云原生 dubbo

故障处理与自动驾驶(63/100)

hackstoic

架构设计

Spring探索丨既生@Resource,何生@Autowired?

阿里巴巴云原生

spring 阿里云 云原生

Java异常处理和最佳实践(含案例分析)

阿里巴巴云原生

Java 阿里云 云原生 JVM

Low-Code,一定“low”吗?

京东科技开发者

低代码 京东云 京东技术 京东科技 企业号 4 月 PK 榜

​openEuler 23.03 正式发布,聚集社区创新力量,增强基础技术能力,协同全场景创新

openEuler

Linux 运维 操作系统 openEuler 桌面开发

自动化测试理解

测试 自动化测试

极客时间运维进阶训练营第二十一周作业

忙着长大#

超级视频播放器:nPlayer for Macv1.4.0中文激活版

真大的脸盆

Mac Mac 系统 视频播放器 视频播放 视频播放软件

如何用一个端口同时暴露 HTTP1/2、gRPC、Dubbo 协议?

阿里巴巴云原生

阿里云 云原生 dubbo

全栈声明式可观测:KubeVela 开箱即用且灵活定制的云原生应用洞察

阿里巴巴云原生

阿里云 开源 云原生 KubeVela

MySql序号递增

源字节1号

软件开发 小程序开发

架构训练营 - 模块八作业

Sam

架构实战营

声明式编程:by example

agnostic

声明式

提升集群吞吐量与稳定性的秘诀: Dubbo 自适应负载均衡与限流策略实现解析

阿里巴巴云原生

阿里云 开源 云原生 dubbo

Python:如何写输入与输出

强劲九

Python

释放商业潜力:掌握成功IT数字化转型的三大关键

L3C老司机

数字化转型 工程效能 业务赋能 胜任力 IT咨询

【原理揭秘】Vite 是怎么兼容老旧浏览器的?你以为仅仅依靠 Babel?

京东科技开发者

前端 企业号 4 月 PK 榜

阿里架构师花近十年时间整理出来的Java核心知识pdf(Java岗)

Java你猿哥

Java java面试 Java工程师 Java面经 春招

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