Sandcastle----强大的C#文档生成工具
Sandcastle是微软官方的文档生成工具，NDoc开发停止后，这个貌似也是唯一的一个这方面的工具。它从dll文件及其xml注释文件能够生成完整的帮助文档，支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),结合新发布的Sandcastle Help File Builder可视化工具，整个生成过程十分简单。
下面我来简单的介绍一下如何使用。
1.先下载最新的Sandcastle后安装.
2.然后下载 Sandcastle Help File Builder. 进行安装，根据提示将需要安装的插件全部安装成功，如果不知道可以选择默认，
3.安装完成后直接新建项目
新建项目，新建之后会看到一个 project Properties的菜单，这里我以 C#帮助文档为例，
选择 Help File 主要是红色区域的部分，选择之后在最右边部分，选择需要添加的 文件， 将dll文件和其对应的xml文件添加到项目中，右键add
4.点击上面的生成菜单或者按钮，就可以直接打开生成过程界面，在这里可以直接查看生成过程中的一些提示和错误.生成完成后，一个和MSDN风格一致的文档就出来了:
5.如果觉得系统生成的不好看，可以通过我的上一篇文章对chm帮助文档进行修改。
需注意：
1、在visio Studio中 相关文件 xml文档的生成。
在生成文档之前，需要说明一点，在VS.NET中，项目属性窗口里，要把“生成XML文档文件”的选项选中。
2、在需要生成的帮助文档代码中要写注释文档，要规范。
关于代码中注释的格式，就用VS.NET自己生成的格式就行（即，在函数定义前面输入///后IDE自动添加的注释格式），如下图。
更多复杂的设置，去官网的文档里查看吧。我就介绍到这里了。
Sandcastle----强大的C#文档生成工具相关推荐
- .NET平台开源项目速览(4).NET文档生成工具ADB及使用
.NET平台开源项目速览(4).NET文档生成工具ADB及使用 原文:.NET平台开源项目速览(4).NET文档生成工具ADB及使用 很久以前就使用ADB这个工具来生成项目的帮助文档.功能强大,在学习 ...
- 猿创征文｜小而巧的API文档生成工具之smart-doc
文章目录 smart-doc介绍 smart-doc特性 smart-doc的最佳搭档 谁在使用smart-doc smart-doc的优缺点 smart-doc和swagger区别比较 smart- ...
- Apiggs —— 非侵入性的 RestDoc 文档生成工具
程序员一直以来都有一个烦恼,只想写代码,不想写文档.代码就表达了我的思想和灵魂. Python提出了一个方案,叫docstring,来试图解决这个问题.即编写代码,同时也能写出文档,保持代码和文档的一 ...
- Doxygen自动文档生成工具在Eclipse中的集成及使用举例
你有为软件编写说明文档的苦恼吗?当别人甩给你一个庞大的系统,让你根据里面的代码注释理解后写出一份完整的开发文档,你会怎么办?一个个的看代码 然后耗时N天来写吗?这既是一份苦差事也极其耗时,有没有更好的 ...
- unity mysql生成cexcel_【C#附源码】数据库文档生成工具支持（Excel+Html）
[2015] 很多时候,我们在生成数据库文档时,使用某些工具,可效果总不理想,不是内容不详细,就是表现效果一般般.很多还是word.html的.看着真是别扭.本人习惯用Excel,所以闲暇时,就简单的 ...
- java 接口文档工具_一款Java基于注释的接口文档生成工具
一. 痛点 你还在手动维护接口文档嘛,花一个下午不停的复制粘贴代码里面的注释 接口字段变动,还得去更新文档,更新不及时导致文档不同步 或者你使用了swagger之类的基于注解,依靠运行时的文档工具,看 ...
- 数据库文档生成工具V1.0
这是一款基于C#开发语言编写的数据库文档生成工具,主要实现了 SQlServer+MYsql 数据库表结构说明文档的生成,并且支持 SQLServer 数据库的备份功能,主要可以把数据库的表以及表的详 ...
- spring-boot 一款无侵入型，轻量级的接口文档生成工具apiggs
spring-boot 一款无侵入型,轻量级的接口文档生成工具apiggs 名字叫:apiggs 使用只需两步,先把插件代码引入pom文件,然后编译打包即可 之后项目的target目录下,就会多出一个 ...
- java接口文档生成工具_接口文档生成
一.为什么要写接口文档? 1.正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要. 2.项目开发过程中前后端工程师有一个统一的文件进行沟通 ...
最新文章
- 【Leetcode】 刷题之路1（python）
- 马斯克的SpaceX又双叒叕融资了：喜提131亿，估值破3000亿
- linux webrtc浏览器,WebRTC 浏览器支持
- MongoDB学习笔记【2】-- 试用
- local sandbox html里的script tag是如何load到memory里的
- 于无声处 启明星辰吹响工控安全号角
- php 各种进制表示,常用的进制有哪些
- ubuntu9.10之grub.cfg详解
- 应用程序正常初始化000007b失败
- oracle_j000,DBA手记:System State转储之ROW CACHE对象
- 【Halcon 计算点到直线和点到直线延长线的距离】
- 2022漂亮有质感的SummerAdmin后台模板+Layui内核
- 设计 QQ、微信、微博、Github 等第三方账号登陆
- 【网课必备】学浪视频下载方法
- 科罗拉多大学波尔得分校计算机科学,CU Boulder的Computer Science「科罗拉多大学波德分校计算机科学系」...
- Mac下手动备份Mysql数据库
- arduino通过CNC SHIELD(A4988)控制两个步进电机
- convs在MATLAB中,vscon美瞳
- 300行代码实现Minecraft(我的世界)大地图生成
- Apache Hudi的流批一体架构实践某宝