• Sandcastle VS2005 .net framework2.0 Ddoc 生成文档


        .net底下,要想生成类似于java的JacaDoc文档,我以前都用NDoc,不过在NDoc1.3.1以后,NDoc的作者Kevin Downs就不再进行NDoc Open Source的开发,所以现在我一般用微软推出的Sandcastle配合Sandcastle Help File Builder来产生Doc文档,本文主要介绍SHFB制作vs.net的Doc文档。

    一、安装Sandcastle
    http://www.codeplex.com/Sandcastle下载最新的Sandcastle。目前最想的版本为Sandcastle May 2008 Release (Version 2.4.10520)。

    二、安装Sandcastle Help File Builder
    其实Sandcastle本身就可以使用命令行的方式来制作Doc文档,不过这样显然一般人不喜欢。Sandcastle Help File Builder就是一款具有UI界面的Sandcastle编译工具,他的界面很Ndoc几乎一样。在http://www.codeplex.com/SHFB上下载最新的安装程序,目前最新版是1.7.0.0。

    三、安装
    先装Sandcastle,再装Sandcastle Help File Builder。和所有的普通WinApp一样,一路next就可以了。然后再开始菜单里找到Sandcastle Help File Builder GUI就可以启动程序了。

    四、使用
    首先,用VS编译你的程序,注意,在编译的时候要选择产生XML文件,这默认是选中的。然后启动程序。如下图

        点ADD按钮,加入要制作的dll和xml,然后点Documentation底下的Build Project执行生成HELP文件。

    Sandcastle Help File Builder常用属性说明:
    ①。HelpFileFormat:Help 文件格式,可复选Help1x(.chm文件),Help2x(.hlp文件吧?),website(html格式文件)格式。
    ②。HelpTitle:Help文件标题。
    ③。HtmlHelpName:输入的文件名。
    ④。Language:Help文件的语言。有很多简体繁体中文都有。还有日文的。
    ⑤。Dependencies:如果编译Help文档时有dll无法找到,可以使用次、此属性加入相关dll。

    我用的时候它一直包The file Itircl.dll has not been registered correctly这个错误,但我无论我如何注册Itircl.dll都不行,继续报这个错误。很郁闷!经过一番google,终于发现原来是要注册一个叫itcc.dll的文件,itcc.dll位于C:\Program Files\HTML Help Workshop下面。

    =============分隔符========================

    不知道大家一般是用什么生成文档的?有什么更好的工具吱一声啊

  • 相关阅读:
    SQL Server逻辑读、预读和物理读
    SQL Server 视图
    SQL Server存储机制
    SQLServer
    数据库配置问题整理贴
    分析存储过程重编译的起因以及避免
    存储过程重编译的优点、缺点、确定引发语句
    查询反模式
    查询反模式
    状压DP的总结
  • 原文地址:https://www.cnblogs.com/harryhan1983/p/sandcastle.html
Copyright © 2020-2023  润新知