【AICon】探索RAG 技术在实际应用中遇到的挑战及应对策略!AICon精华内容已上线73%>>> 了解详情
写点什么

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

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

关注

评论

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

TDengine 落地协鑫能科,数百亿数据压缩至 600GB

TDengine

数据库 tdengine 时序数据库

Spark数据格式UnsafeRow

矛始

spark 内存 UnsafeRow

技术风向标 | 云原生技术架构成熟度模型解读

阿里巴巴云原生

阿里云 云原生 成熟度模型

[ Kitex 源码解读 ] 服务发现

baiyutang

Go 微服务架构 kitex CloudWeGo

如何通过学会提问,成为更加优秀的数据科学家

Baihai IDP

AI 数据科学 职业发展

超越 Nginx!号称下一代 Web 服务器,用起来够优雅

冉然学Java

Java nginx GitHub 服务器 Web、

spark-streaming状态流之mapWithState

矛始

spark 状态流

2022 云原生编程挑战赛火热报名中!看导师如何拆解 Serverless 赛题?

阿里巴巴云原生

阿里云 Serverless 云原生编程挑战赛

浅谈云原生边缘计算框架演进

谐云

7月月更

就这一次!详细聊聊分布式系统的那些技术方案

Java全栈架构师

程序员 面试 分布式 系统设计 架构师

兆骑科创海外高层次人才引进平台,创业赛事活动路演

兆骑科创凤阁

高层次人才引进平台

极大似然估计

矛始

概率 极大似然估计

基础到高级涵盖11个技术,Alibaba最新出品711页Java面试神册真香

程序员小毕

Java 面试 程序人生 JVM 中间件

一文讲清楚SpringBoot六种读取配置方式

王小凡

Java 程序员 Sprint Boot

菜鸟 CPaaS 平台微服务治理实践

阿里巴巴云原生

阿里云 微服务 云原生 CPaaS 菜鸟

如何借助自动化工具落地DevOps|含低代码与DevOps应用实践

云智慧AIOps社区

开源 DevOps 低代码平台 开发与运维

6种方法帮你搞定SimpleDateFormat类不是线程安全的问题

华为云开发者联盟

高并发 开发

kudu设计-tablet

矛始

kudu tablet

图的遍历的定义以及深度优先搜索和广度优先搜索(一)

乔乔

7月月更

2022最新最全Java面试八股文(整整1685页,14个技术栈,20余万字)

Java全栈架构师

Java spring 面试 JVM 消息中间件

Qakbot新型感染链:使用Windows7系统侧加载感染设备

郑州埃文科技

dll Windows7 Qakbot

公共数据如何兼顾开放利用和隐私安全合规?

Jessica@数牍

数据安全 隐私计算 公共数据开放 数据开放和利用

导数、微分、偏导数、全微分、方向导数、梯度的定义与关系

矛始

高数 导数 微分

机器视觉在服务机器人中的应用

优必选科技

机器人

融云直播 SDK 玩法翻新,入围信通院「实时互动创新应用优秀案例」

融云 RongCloud

直播 sdk

有一说一,阿里P7的薪资待遇是真的香

程序员小毕

Java 程序员 程序人生 后端 架构师

研发效能的道与术 - 道篇

FreeW

架构 研发效能

netty入门之服务端启动过程分析

Hex

Java 后端 Netty

深圳云管平台厂商哪家好?有哪些功能?咨询电话多少?

行云管家

云计算 云管平台

Spark统一内存划分

矛始

spark 统一内存

MySQL精品学习资源合集 | 含学习教程笔记、运维技巧、图书推荐

墨天轮

MySQL 数据库 学习笔记 运维技术

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