WEB开发网
开发学院软件开发C语言 Sandcastle入门:创建C#帮助文档 阅读

Sandcastle入门:创建C#帮助文档

 2009-04-21 08:26:04 来源:WEB开发网   
核心提示:使用Sandcastle4.1使用平台(1)操作系统:Windows Server 2003; Windows XP Service Pack 2; Windows Vista;(2)必备软件:Microsoft .NET Framework Version 2.0HTML Help Workshop—&m

使用Sandcastle

4.1使用平台

(1)操作系统:

Windows Server 2003; Windows XP Service Pack 2; Windows Vista;

(2)必备软件:

Microsoft .NET Framework Version 2.0

HTML Help Workshop——如果需要编译生成CHM文档(需要用到其中的hhc.exe文件)

(3)可选软件:

Visual Studio 2005

MS Help Compiler from VS SDK

4.2使用方式(可选界面)Ref[2]

(0)使用Sandcastle原始的命令行方式

(1)Sandcastle Help File Builder

它提供一个类似于NDoc的界面,允许你输入现有的NDoc项目,自动完成创建过程。

(2)SandcastleGUI

这是一个免费的Sandcastle GUI前端界面。利用它可以在图形界面操作,省去用户输入命令行的麻烦。并且具有以下扩充Ref[6]:

=============================================================================

>>自动在文档中插入MSDN文章链接

>>可以选择程序集中的某个命名空间生成文档,而不是默认的整个程序集

>>多种输出方式:网站、CHM帮助文件或输出二者

>>自定义帮助文档头部(公司LOGO以及产品名称等)

>>自定义帮助文章页脚(版权信息等)

>>在文档中插入自定义的图像

>>文档的代码实例中将C#语法高亮显示

=============================================================================

(3)Sandcastle CHM编译BAT脚本和配置实用工具

这是一个配置实用工具和批处理脚本,由它通过Sandcastle可建立MSDN形式的类文档CHM文件。

(4)DocProject

1 2 3 4  下一页

Tags:Sandcastle 入门 创建

编辑录入:爽爽 [复制链接] [打 印]
赞助商链接