最新发布《数智时代的AI人才粮仓模型解读白皮书(2024版)》,立即领取! 了解详情
写点什么

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

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

关注

评论

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

打工人的第27天-平凡但不平淡的日子

Amazing_eve

#开源

2022年裁员潮,失业程序员何去何从?

千锋IT教育

呵呵,JavaScript 真好玩(苦笑脸)

掘金安东尼

JavaScript 前端 8月月更

短视频软件开发——平台同质化如何破局

开源直播系统源码

软件开发 直播源码 短视频直播源码 短视频直播系统源码

STM32封装ESP8266一键配置函数:实现实现AP模式和STA模式切换、服务器与客户端创建

DS小龙哥

8月月更

开源一夏 | mysql5.7安装部署-yum安装

zhangpfly

MySQL 开源 linux运维 #开源 8月月更

StoneDB 文档捉虫活动第一季

StoneDB

MySQL 数据库 开源 大数据 开源 8月月更

谷歌数据中心发生“电力事故”造成 3 人受伤

雨果

数据中心 谷歌

C++运算符重载(二)之左移运算符重载

CtrlX

c c++ 进阶 重载 8月月更

OneFlow源码解析:算子指令在虚拟机中的执行

OneFlow

虚拟机 源码解析 算子

中小规模网站架构

舟停江吹雪

Linux

从脚本到剪辑,影像大师亲授的后期制作秘籍

博文视点Broadview

Gitlab刚发布一项禁止使用 Windows 的公司政策

雨果

gitlab Github'

企业如何判断数据治理是否成功?

雨果

数据治理

Linux服务器端网络抓包和分析实战

程序员欣宸

Java Linux 8月月更

是什么影响了MySQL性能?

TimeFriends

8月月更

50个Java面试必问的面试题,这里都给你整好了

千锋IT教育

一起畅聊「云+操作系统」!龙蜥社区亮相阿里巴巴开源开放周,完整议程来了

OpenAnolis小助手

数据库 操作系统 龙蜥社区 阿里巴巴开源开放周 开源共享

Kyligence 通过 SOC 2 Type II 审计,以可信赖的企业级产品服务全球客户

Kyligence

国际权威鉴证标准 企业级数据分析

面试突击73:IoC 和 DI 有什么区别?

王磊

Java 常见面试题

GPU加速Pinterest推荐模型,参数量增加100倍,用户活跃度提高16%

OneFlow

机器学习 深度学习 gpu

Netty进阶 -- 非阻塞网络编程 实现群聊+私聊+心跳检测系统

Bug终结者

Netty 8月月更

8月份DB-Engines 数据库排行榜最新战况

雨果

数据库

SQL与NoSQL最终会走向融合吗?

雨果

nosql sql

使用CSS实现多种Noise噪点效果

dragonir

CSS html html5 css3

不止跑路,拯救误操作rm -rf /*的小伙儿

华为云开发者联盟

开发 配置文件 OM脚本

学Python爬虫,不看看m3u8文件如何加密?i春秋 m3u8 文件加密解析

梦想橡皮擦

Python 爬虫 8月月更

Gartner再次重申了“数据编织”的重要价值

雨果

数据编织

快速上手,征服三种不同分布式架构调用方案

知识浅谈

分布式 8月月更

JWT 实现登录认证 + Token 自动续期方案

CRMEB

Open Office XML 格式里如何描述多段具有不同字体设置的段落

Jerry Wang

xml 微软 Office 8月月更 openOffice

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