Sandcastle的使用

简介: Quote:Sandcastle, created by Microsoft, is a tool used for creating MSDN-style documentation from .

Quote:Sandcastle, created by Microsoft, is a tool used for creating MSDN-style documentation from .NET assemblies and their associated XML comments files. The current version is the May 2008 release. It is command line based and has no GUI front-end, project management features, or an automated build process like those that you can find in NDoc. The Sandcastle Help File Builderwas created to fill in the gaps, provide the missing NDoc-like features that are used most often, and provide graphical and command line based tools to build a help file in an automated fashion.


  Sandcastle是一个由微软制作的,依赖.NET程序集及其相关的XML文件生成MSDN形式的文档帮助的工具,现在最新的版本是2008月5月发布的。通过这个工具可以方便地制作出帮助文档,但她是基于命令行的,没有GUI前端界面,项目管理功能,或你可以在NDoc中可以找到的自动生成功能,而Sandcastle Builder填补了Sandcastle的空白,提供了缺失的类似于NDoc提供的功能,并提供了基于图形和命令行的工具来自动建立一个帮助文件。

  这次项目的过程中就俺也使用了Sandcastle Builder,主要是用来生成项目中的API帮助文档,小记一下:

  

  使用步骤:

  一、建立一个叫Hello的类库,象征性的建立一个HelloWorld类,在类中写个Test方法,并给上一些Summary标签注释, 随后进入项目属性中的生成选项设置

  

  上面已经提到Sandcastle Builder要有XML文件的配件支持,所以这里要在项目输出栏选中XML 文档文件,保存即可。

  

  2、F6编译项目,就可以看到在Debug目录下找到DLL和XML文件了,下面该Sandcastle Builder登场了。

  

  3、首先在Sandcastle Builder的Documentation Sources里面添加DLL和XML文件。

  

  4、随后就进行一些需要的设置好了,常见的都用黑体标出,当然,如果FrameworkVersion不符合的话还需要设置一下,这个是2008年发布的,所以就别期望能够支持到4.0了哈^_^

  

  5、因为要配合微软的另一款HTML Help Workshop工具,所以这里要设置它的路径,最后指定输出目录和Sancastle的目录就好了

  

  

  6、看一下Build之后的目录文件:

  

  打开看一下效果:

  

  

  

  效果不错,很实用的东西^_^

 

 

from:

http://www.cnblogs.com/RockyMyx/archive/2010/04/30/Project-Route-Using-SandcastleBuilder.html
目录
相关文章
|
5月前
|
存储 数据库 Docker
Docker Hub和镜像仓库
Docker Hub 是 Docker 公司提供的官方公共 Docker 镜像注册表,允许用户存储、分享和获取 Docker 镜像。在 Docker Hub 上,你可以找到许多官方和社区维护的 Docker 镜像,这些镜像涵盖了各种常见的应用程序和服务,如数据库、Web 服务器、应用程序框架等。
3145 0
|
C++ Windows
VS Code 切换中英文
VS Code 切换中英文
1319 0
VS Code 切换中英文
|
消息中间件 SQL 存储
超详细的RabbitMQ入门,看这篇就够了!
RabbitMQ入门,看这篇就够了
181133 56
|
11月前
|
Web App开发 测试技术 文件存储
干掉PostMan!IDEA这款插件太实用了…
接口调试是每个软件开发从业者必不可少的一项技能,一个项目的的完成,可能接口测试调试的时间比真正开发写代码的时间还要多,几乎是每个开发的日常工作项。所谓工欲善其事必先利其器,在没有尝到IDEA REST真香之前,postman(chrome的一款插件)确实是一个非常不错的选择,具有完备的REST Client功能和请求历史记录功能。但是当使用了IDEA REST之后,postman就可以丢了,因为,IDEA REST Client具有postman的所有功能,而且还有postman没有的功能,继续往下看。
|
11月前
|
Unix Linux API
开源库介绍:libusb 及其使用
开源库介绍:libusb 及其使用
2416 0
开源库介绍:libusb 及其使用
|
Java 程序员 API
IDEA插件开发(一)
IDEA插件开发
2101 0
marked覆盖A标签的解析规则
在使用marked来做md解析的时候,部分解析规则可能并不是很如意,比如说,我在md中写了a标签,但是这些标签都是在当前页面替换的,而我想要的是新打开窗口。
marked覆盖A标签的解析规则
|
API 网络架构
docfx 简单使用方法、自动生成目录的工具
docfx 简单使用方法、自动生成目录的工具
287 0
|
Java
IDEA打包JAR的多种方式
  用IDEA自带的打包形式 用maven-shade-plugin打包 org.apache.maven.
3782 0