Sandcastle的使用

摘要:
2.使用F6编译项目时,可以看到DLL和XML文件位于Debug目录中。现在是SandcastleBuilder。

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. TheSandcastle 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的使用第1张

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

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

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

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

Sandcastle的使用第2张

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

Sandcastle的使用第3张

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

Sandcastle的使用第4张

打开看一下效果:

Sandcastle的使用第5张

Sandcastle的使用第6张

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

from:

http://www.cnblogs.com/RockyMyx/archive/2010/04/30/Project-Route-Using-SandcastleBuilder.html

免责声明:文章转载自《Sandcastle的使用》仅用于学习参考。如对内容有疑问,请及时联系本站处理。

上篇学习《深入理解计算机系统》第四章摘要EJB3 阶段总结+一个EJB3案例 (1)下篇

宿迁高防,2C2G15M,22元/月;香港BGP,2C5G5M,25元/月 雨云优惠码:MjYwNzM=

相关文章

XStream xml 解析框架使用笔记

1. xml的标签可以映射为类、类成员变量 2. 有子标签的标签映射为类,没有子标签的便签映射为类成员变量 3. 类名、类成员变量名如与标签名不一致需要通过注解或代码设置别名 1 //类名 2 @XStreamAlias("Info") 3 xStream.aliasType("Info", YLTextInfo.class); 4 //类成员变量名 5...

XML的几种转换

1 package com.qbskj.project.util; 2 3 import java.io.ByteArrayOutputStream; 4 import java.util.ArrayList; 5 import java.util.HashMap; 6 import java.util.Iterator; 7...

springboot整合log4j2

前言   这里日志分两种。一种是tomcat的输出(系统)日志,一种是自己定义的日志。 环境   springboot版本1.5.6。(springboot1.4以上则使用log4j2,一定要注意版本) 1、springboot默认日志logback的日志输出样式如下: 2、排除springboot的默认日志logback,使用exclusion排除默认...

jenkins参数化配置,pom.xml配置

1、要实现Jenkins参数化构建,要先在代码里写好能接收该参数value的配置,在pom.xml文件里加配置,如下:   1)<properties></properties>里添加参数的key和value,通过本地执行时,可以直接从pom文件获取,或者从config.properitites获取   l  <propert...

位置动画Android的Activity屏幕切换动画(一)左右滑动切换

查了好多资料,发现还是不全,干脆自己理整吧,至少保证在我的做法正确的,以免误导读者,也是给自己做个记录吧!     在Android发开中程过,经常会到碰Activity之间的换切效果的题问,上面绍介一下如何实现阁下滑动的换切效果,首先懂得一下Activity换切的实现,从Android2.0开始在Activity增加了一个方法:     public v...

利用OpenXml生成Word2007文档

一、OpenXml简介 利用C#生成Word文档并非一定要利用OpenXml技术,至少可以使用微软提供的Office相关组件来编程,不过对于Office2007(确切的说是Word、Excel和PowerPoint2007)及以上版本,微软提供了这些信息组织的另外一种思路:OpenXml技术。         OpenXml是微软office2007及之后...