`
xiaoheliushuiya
  • 浏览: 404215 次
文章分类
社区版块
存档分类
最新评论

文档生成工具Sandcastle的使用

 
阅读更多

(1) 安装 Sandcastle.(安装文件下载地址:http://sandcastle.codeplex.com/releases/view/47665)
(2) 准备好需要生成文档的DLL文件和XML注释文件。
(3) 运行SandcastleGui.exe程序。(默认的文件路径是 C:\Program Files (x86)\Sandcastle\Examples\Generic)
(4) 从上至下依次添加DLL文件、XML注释文件、依赖DLL文件(可选项。如果被生成文档的DLL有引用则添加;反之,则不添加)。
添加完成后,在右上角填写生成文件的名称。


(5) 安装 HTML Help Workshop.exe 程序。HTML Help Workshop的安装文件下载地址是
http://www.microsoft.com/downloads/details.aspx?familyid=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en
默认的文件安装路径是:C:\Program Files (x86)\HTML Help Workshop
(6) 运行HTML Help Workshop.exe 程序。单击File菜单,选择Compile。
在弹出的窗体中选择前面使用Sandcastle生成的文件 .hhp文件,单击确定按钮。


(7) 如果生成成功,会在 C:\Program Files (x86)\Sandcastle\Examples\1111\vs2005\chm 目录下增加一个新文件 *.chm
*.chm文件就是最终的文档。

分享到:
评论

相关推荐

    Sandcastle 文档生成工具

    Sandcastle 微软官方的文档生成工具

    Sandcastle代码帮助文档生成器

    Sandcastle代码帮助文档生成器。 使用 Sandcastle可以生成MSDN风格的帮助文档,生成的帮助文档既可以是chm文档,也可以是MS Help 2.x帮助文档。

    Sandcastle VS注释文档生成工具

    Sandcastle(CodeName)是微软出的用于编译发布组件(Assembly)信息的一个工具,基本上等同于NDoc(后者已经停止开发很久了)。这个工具通过反射和Xslt技术,可以从dll文件及其xml注释(编译时加/doc参数得到),...

    强大的C#API文档生成工具

    Sandcastle是微软官方的文档生成工具,NDoc开发停止后,这个貌似也是唯一的一个这方面的工具。它从dll文件及其xml注释文件能够生成完整的帮助文档,支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView...

    SandcastleHelpFileBuilder2017有一个25页的使用说明文档

    这个是c#类库方法根据注释生成帮助文档的工具,我们经常会遇到把DLL或者API提供给别人调用的情况,通过在方法中添加注释,然后再用Sandcastle 来自动生成文档给调用者,如下 单纯Sandcastle好像是没有界面的, 这个...

    Sandcastle

    Sandcastle 是一个文档生成工具,可以用它生成 MSDN 风格的文档,既能够生成 chm 文档,也能够生成 MS Help 2.x 帮助文档。在此之前曾流行的 NDoc,其作者已经放弃更新。 参考: ... ... 安装说明:安装...

    Sandcastle-帮助生成工具

    Sandcastle生成帮助,有GUI,也有VS插件。很强大,用着很方便。 1、创建Sandcastle项目 2、添加VS项目源文件 3、点击生成 即可生成帮助文档,默认为CHM格式,还支持多种格式。

    Sandcastle加图形工具加中文模板

    自动根据 VS2005 VS2008 的 XML注释生成CHM帮助文档的软件、模板、帮助 包含以下文件: Sandcastle2.4.10520.zip:命令行界面的Sandcast,界面是英文的。 SandcastleBuilderSetup_1801.zip:第三方开发GUI界面方便...

    .Net文档自动生成

    压缩包中包含Sandcastle和它的GUI工具,很好用的

    vs注释生成帮助文档

    里面是包含2个工具和一个使用说明文档,通过我自己使用总结的步骤和网上详细的说明。 包含内容: Sandcastle.msi SandcastleGUI.exe 使用帮助.CHM 非常好的通过代码注释生成文档的工具,和MSDN一样酷!

    NuDoc:.NET 框架语言的文档生成器

    NuDoc 是 .NET 框架语言的 API 文档生成器。 NuDoc 使用反射来读取有关程序集中类型的信息。 它还可以从嵌入在源代码中的特殊文档注释中读取编译器生成的 XML 文档文件。 给定一个 .NET 程序集及其匹配的 XML 文档...

    使用GhostDoc为代码生成注释文档

    C#中XML格式的文档注释好处多多:Visual Studio会在很多地方显示这些注释内容(例如,编辑器的工具提示或对象浏览器),还有一些工具(比如NDoc或微软的文档工具Sandcastle)也可以利用这些注释生成具有良好外观的...

    Sandcastle Help File Builder

    10:HtmlHelpName:文档生成文件名称 11:PresentationStyle: 支持vs 2005,Prototype等格式 ,根据自己需要选择 12: OutputPath:生成路径,即最后chm文件存放位置,当然除了CHM还有些其它文件。 13:...

    C#.NET必备工具GhostDoc为代码生成注释文档GhostDocPro_v4.5_Cracked

    C#中XML格式的文档注释好处多多:Visual Studio会在很多地方显示这些注释内容(例如,编辑器的工具提示或对象浏览器),还有一些工具(比如NDoc或微软的文档工具Sandcastle) 也可以利用这些注释生成具有良好外观的...

    SHFB:沙堡帮助文件生成器(SHFB)。 独立的GUI,Visual Studio集成包和MSBuild任务提供了完整的配置和可扩展性,以使用Sandcastle工具构建帮助文件

    欢迎使用Sandcastle帮助文件生成器项目。 该项目由两个相互配合的独立部分组成:Sandcastle工具和Sandcastle帮助文件生成器。 Sandcastle工具用于为包含概念和API参考主题的托管类库创建帮助文件。 通过将源代码中...

    SHFBGuidedInstallation

    Visual Studio 注释自动生成文档工具 Sandcastle完整版 包括Sandcastle Help File Builder

    SharpDoc:SharpDoc是一个文档工具,可以为.NET项目生成HTML文档。

    SharpDoc是一个文档工具,用于为.NET项目生成HTML文档。 可以在找到 该文档系统提供了高质量的文档和完全生成的类API参考。 当前功能是: 从.NET程序集和XML文档文件生成类API参考 使用简单而强大的Razor模板引擎...

    .Net十大必备工具之一

    .Net十大必备工具 1. Snippet Compiler Snippet Compiler 是一个基于 Windows 的应用程序,可以通过它来编写、编译...NAnt是基于.NET的生成工具,与版本Visual Studio.NET 不同,它使得你的项目创建生成过程变得容易。

    .Net十大必备工具之二

    .Net十大必备工具 1. Snippet Compiler Snippet Compiler 是一个基于 Windows 的应用程序,可以通过它来编写、编译...NAnt是基于.NET的生成工具,与版本Visual Studio.NET 不同,它使得你的项目创建生成过程变得容易。

Global site tag (gtag.js) - Google Analytics