Sandcastle初探——官方版的NDoc
Sandcastle(CodeName)是微软出的用于编译发布组件(Assembly)信息的一个工具,基本上等同于NDoc(后者目前已经停止开发,最新版本仍然不支持.Net 2.0)。这个工具通过反射和Xslt技术,可以从dll文件及其xml注释(编译时加/doc参数得到),得到一个完整的帮助文档,格式可以是Html或CHM甚至是任何自定义的格式。当前Sandcastle最新版本是June CTP。使用方式仍然是命令行,而官方网站上给出的使用说明只能支持单一的Dll,也就是Project,对于Solution仍然没有任何说明。其Blog上介绍说以后会有GUI和VS.Net 2005 Add-In等使用方式。现在让我们来先睹为快。
Sandcastle June CTP的下载地址http://www.microsoft.com/downloads/details.aspx?FamilyID=e82ea71d-da89-42ee-a715-696e3a4873b2&DisplayLang=en,如果你需要编译生成CHM文档,还需要HTML Help Workshop,下载地址http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp
以上两个文件的安装很简单,一直点击下一步就可以成功安装。安装时强烈建议使用默认的路径。
编译文档的方法有两种,一种是使用我写的Bat文件(前提是安装使用的是默认路径),下载地址/Files/yuandong/sandcastlebuild.rar:使用方法如下:
1.下载并安装Sandcastle和HTML Help Workshop,使用默认路径。
2.点这里下载编译文件,解压缩。包含三个文件:build.bat,build.config,build.hhp。
3.将以上三个文件拷贝到Project的bin的Debug目录下。(假设要编译的组件名成为Assembly,确定目录下至少包含Assembly.dll和Assembly.xml,后者为XML注释。如何产生XML注释参见http://msdn2.microsoft.com/zh-CN/library/b2s063f7.aspx )
4.开一个CMD,导航到Debug目录。
5.键入“build 组件名”上例中即为“Build Assembly”。
6.生成的文件在Debug的Output目录下。
以下为我生成的CHM的截图:
下的“组件名+Html”目录下为Html格式的文件,名称使用的是GUID,一般来说大小最小的为首页,复制一个,改名为Index.htm就可以发布了。以下为Html的截图:
请注意上图最低部的版权信息:“(c) It.ouc.edu.cn. All rights reserved. Send comments about this topic to aq08good@gmail.com.”此信息从C:/Program Files/Sandcastle/Presentation/Content/shared_content.xml里面设置(默认是微软)。
从截图中可以看到,Sandcastle对中文的支持很好,而且生成的默认格式是我们再熟悉不过的MSDN风格。
注意,以上方法只适合没有依赖的组件,对于有依赖的组件,需要修改Bat文件,详细方法在Bat文件中有详细的注释。
第二种编译的方法是官方发布的方法,详情参看https://blogs.msdn.com/sandcastle/archive/2006/07/29/682398.aspx,E文很简单,我就不翻译了。这种方法比较麻烦,有问题的可以留言讨论。
从以上介绍可以看出,Standcastle的编译生成已经很成熟了,而且从分析来看,其可定执行相当强大。只是使用方法还很简陋,离实际使用还有距离,毕竟还是CTP版本。不过相信微软的东西,最终易用性应该是让人满意的。更多内容可以参考:
https://blogs.msdn.com/sandcastle/default.aspx
http://forums.microsoft.com/MSDN/ShowForum.aspx?ForumID=66&SiteID=1
或留言讨论。
Output
Chm 工具制作
需要3个工具:
Sandcastle:微软官方的,文档生成引擎
DocProject:一个文档工程插件,要基于Sandcastle安装了才能使用
HtmlHelp:微软官方的,CHM文件生成引擎
分享到:
相关推荐
Sandcastle 微软官方的文档生成工具
在此之前曾流行的 NDoc,其作者已经放弃更新。 参考: http://blog.sina.com.cn/s/blog_6f72ff900102vbur.html http://www.cnblogs.com/net515/p/3311584.html 安装说明:安装SandcastleInstaller.exe 安装...
微软的Sandcastle和SandcastleHelpFileBuilder,可以根据注释自动生成帮助文档,只要是注释写得好,文档生成的就漂亮
微软的Sandcastle和SandcastleHelpFileBuilder,可以根据注释自动生成帮助文档,只要是注释写得好,文档生成的就漂亮!
Sandcastle生成帮助,有GUI,也有VS插件。很强大,用着很方便。 1、创建Sandcastle项目 2、添加VS项目源文件 3、点击生成 即可生成帮助文档,默认为CHM格式,还支持多种格式。
Sandcastle(CodeName)是微软出的用于编译发布组件(Assembly)信息的一个工具,基本上等同于NDoc(后者已经停止开发很久了)。这个工具通过反射和Xslt技术,可以从dll文件及其xml注释(编译时加/doc参数得到),...
Sandcastle2.4.10520.zip:命令行界面的Sandcast,界面是英文的。 SandcastleBuilderSetup_1801.zip:第三方开发GUI界面方便编译为chm文件,界面是英文的。 zh-CN_Docs.zip:生成中文 CHM 所需要的模板。 ...
个人使用sandcastle的总结,大家可以参考下
Sandcastle(包含一个25页的使用文档) 这个是c#类库方法根据注释生成帮助文档的工具,我们经常会遇到把DLL或者API提供给别人调用的情况,通过在方法中添加注释,然后再用Sandcastle 来自动生成文档给调用者,如下 ...
sandcastle源代码sandcastle源代码sandcastle源代码sandcastle源代码2009-10-10
Sandcastle(.net程序集CHM帮助文件生成器)
一般不用安装VS 的 SHFB插件。 SHFBInstaller_v2017.5.15.0,免费版。 含: SHFBVisualStudioPackage_VS2013.vsix SHFBVisualStudioPackage_VS2015AndLater.vsix 按安装提示,逐个安装即可。
本地化的 vs2005 文档样式。
Sandcastle是微软官方的文档生成工具,NDoc开发停止后,这个貌似也是唯一的一个这方面的工具。它从dll文件及其xml注释文件能够生成完整的帮助文档,支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView...
制作 HELP 文件,为程序生成帮助文件。
Sandcastle Help File Builder v2017.5.15.0, 至少要安装 vs2015才能运行
Codeplex上SandCastle源码中缺少的资源, sandcastle需要这些资源生成帮助文件
Sandcastle代码帮助文档生成器。 使用 Sandcastle可以生成MSDN风格的帮助文档,生成的帮助文档既可以是chm文档,也可以是MS Help 2.x帮助文档。