HarmonyOS开发者限时福利来啦!最高10w+现金激励等你拿~ 了解详情
写点什么

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

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

关注

评论

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

人社大赛算法赛题解题思路分享+第五名

阿里云天池

#大数据

第三期安全AI挑战者计划-文本分类对抗攻击 第十名「你钉起来真好听」技术总结

阿里云天池

2021全国数字生态创新大赛-智能算法赛季军方案 乘风破浪的炼丹师队

阿里云天池

“智启新机 云驱增长”——2024腾讯全球数字生态大会

ToB行业头条

怎么制作韦恩图?用这款在线白板绘制简单又漂亮!

职场工具箱

效率工具 职场 在线白板 办公软件 绘图工具

智能弹性实践:Kubernetes HPA 与观测云的自定义指标集成

观测云

k8s

AutoGPT理念与应用

霍格沃兹测试开发学社

袋鼠云产品功能更新报告11期|能力AI+,实力拿捏!

袋鼠云数栈

如何实现持续、主动、长效的数据治理?主动元数据或是最佳答案

Aloudata

数据治理 元数据 全链路数据血缘 数据血缘 数据链路

豆瓣评分9.4!最适合Python入门后进阶的Python食谱!

我再BUG界嘎嘎乱杀

Python 编程 后端 开发语言

Michael Rey谈质押的未来:“节点切片是流动性的关键”

股市老人

API集成的未来:行业级解决方案的发展趋势

幂简集成

API API集成

赛题解析 | 初赛赛道三:服务网格控制面分治体系构建

阿里云天池

云原生

机器学习算法常用指标总结

阿里云天池

使用poetry来更优雅的管理 python 包

我再BUG界嘎嘎乱杀

Python 编程 后端 开发语言 Poetry

Match与RFG:颠覆传统社交,开启价值社交新时代

股市老人

调试理解 NodeJS 模块机制sh

yuanyxh

node.js js Node

聚道云软件连接器8月新增应用合集(3)

聚道云软件连接器

功能更新

智扣物联,“论剑”长沙!2024全国大学生物联网竞赛火山引擎赛道获奖名单重磅揭晓

火山引擎边缘云

物联网 边缘计算 AIOT 智能IoT边缘服务 人工智能’

2025年中国(成都)国际航空航天及无人机展会

秋硕展览

2024第35届中国(广州)国际大健康产业博览会

秋硕展览

[LINUX使用] iptables/tcpdump/wireshark/tshark

百度搜索:蓝易云

9k star 监控系统,100% 国产,推荐了解

巴辉特

Prometheus Nightingale

Python进行Socket接口测试的实现

我再BUG界嘎嘎乱杀

Python 编程 后端 socket 接口测试

Monorepo:让你的项目脱胎换骨,既能代码复用,又能独立部署!

OpenTiny社区

开源 前端 组件库 OpenTiny

一文揭秘:火山引擎云基础设施如何支撑大模型应用落地

Geek_2d6073

活动报名:从手搓 AI bot 到多模态 AI agent+TEN 框架丨 RTE Meetup,上海,8.31

声网

项目管理新趋势,10款工具引领未来工作模式

爱吃小舅的鱼

项目管理 项目经理

释放生产力:JNPF低代码开发平台的五大优势

不在线第一只蜗牛

低代码 数字化

ubuntu 20.04设置authorized_keys让VS Code ssh远程免密连接

百度搜索:蓝易云

Tomcat报BAD packet signature 18245错误的原因

百度搜索:蓝易云

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