工具,用于创建MSDN风格的文档。NET程序集和相关的XML注释文件。目前的版本是2008年5月发布。它是基于命令行的神器出山:www.shenqi73.com,有没有GUI前端,项目管理功能,或自动构建过程中,你可以找到在NDoc的。
沙堡帮助文件生成器应用的开发,填补空白,提供缺少的的NDoc的类似的功能,是最常用的,以自动化的方式,提供基于图形和命令行工具来构建一个帮助文件。
另外的帮助文件生成器,下面的自定义生成组件提供:
- 一个代码块组件,它扩展了XML注释标记文件包含语法高亮,行号,可折叠#地区的#if /##ELSE / ENDIF部分,并复制到剪贴板“选项。这是可用的参考和概念的内容。
- 变换后的组件,可以用来添加徽标图像的每一页的标题,做一些小的调整的语法部分,并添加基本的版本信息的帮助主题。这是可用的参考和概念的内容。
- “秀失踪”的组成部分,增加了“失踪”的说明缺少总结,退货,参数,值,和言论的文档标记,而且还可以自动文档构造。
- 智能感知组件,用于提取XML注释文件,可以用于智能感知。只有基本的标签出口所需的智能感知和记录API。这可以大大减少的IntelliSense文件的大小,并删除所有私人的实施细节时,只记录的公共API。
- 帮助属性的组件,它可以用来添加额外的MSHelp:ATTR属性,每个生成的API主题。添加额外DocSet和其他属性由默认桑德尔卡瑟转换未添加的主题,这是非常有用的。
一个JavaScript的声明语法生成器,可用于普通的JavaScript以及脚本#项目。
- 解决概念构建组件,修复了一些错误,在标准版本的组件,还增加了一些新的功能。
- 一组缓存,建立数据组件,缓存等关键信息的评论,反射率信息和MSDN的网址,跨版本,以加速他们。
下面是一些主要特点的“沙堡帮助文件生成器“:
·GUI界面提供了一个的NDoc的类似属性窗口,所以任何人都熟悉NDoc的,应该是相当舒适的使用它。此外,它提供了类似Visual Studio的项目资源管理器,可让您管理和编辑这些文件与项目相关的。
·生成器能产生的HTML帮助1.x(CHM)文件,HTML帮助的2.x中(HXS)文件,和/或一个网站。
·HTML帮助2.x的输出包括一组有效收集文件和H2Reg.exe的配置文件中的帮助文件,以简化部署和集成到现有的集合,例如Visual Studio中使用。
·网站输出包含HTML和ASP.NET索引页面的树状视图可用于浏览表中的目录和全文索引搜索功能。
·设置都保存在一个标准的MSBuild格式的项目文件,在命令行中使用MSBuild,或在生成后步骤的Visual Studio项目运行MSBuild的,可以在独立的GUI构建。计划在未来的版本支持完整的Visual Studio集成。
·A项目文件转换选项可以从其他第三方工具,如NDoc的,DocProject,SandcastleGUI,例如沙堡MSBuild项目格式的帮助文件生成器的GUI提供转换项目。
直接支持的文档资源的Visual Studio 2005/2008的解决方案和项目文件。帮助项目建成后,组件,XML注释文件和参考信息是从他们那里进口和自动使用。
此外,可执行文件(EXE)和库(DLL)组件可以单独添加的文档的来源,以及任何相关的XML注释文件。
·依赖引用,也可以单独指定。文件,海关总署,项目和COM引用的支持(支持COM引用在项目文件中,但目前还无法通过添加独立的图形用户界面)。
·生成器会自动定位Sandcastle城堡和HTML帮助编译器在通用环境变量,在系统路径中,并在程序文件的特殊文件夹上的所有固定硬盘驱动器。属性也为你提供指定的路径在场外的机会,它不能自动找到它们。
·构建过程提供了完整的记录和错误处理。所有生成的输出存储在日志文件中输出文件夹中。日志是XML格式的,可以通过XSL转换,使其更具可读性跑,要突出警告和错误,等等。
·用于创建帮助文件的中间文件被放置在您所选择的输出文件夹的工作文件夹下。他们可以编译成功后,自动删除或保留为进一步修改。
的NDoc的功能已经内置到沙堡帮助文件生成器,包括:
·项目总结和命名空间的汇总意见,会出现在帮助文件中的定义。您还可以轻松显示的命名空间中包含或排除的帮助文件。还包括支持指定的评论通过一个NamespaceDoc的类内每个命名空间的命名空间。
·关闭文档的属性和其他各种不必要的API元素的能力。
·自动确定默认主题的帮助文件。
·您的帮助文件名,标题,标题文字和页脚信息,如e-mail地址,版权文字和版权URL的控制权。
·支持概念的内容完全集成。这使您可以定义额外的内容出现在表中的内容,如使用说明,教程等概念内容的创建使用Microsoft援助标记语言(MAML)。
标准的HTML文件也可以被纳入合并表中的内容。站点地图文件可以用来定义布局。
·选择语言和本地化的支持是内置的。翻译的帮助文件生成器在几种语言和信息的资源文件提供关于如何定位的沙堡,内容的文件。
已采取步骤,以使过程更加公开,让你有机会来定制它,而无需修改代码生成器应用程序本身。自定义生成过程中的插件,可以用于扩展或改变的构建过程中以各种方式支持。提供的帮助文件生成器的插件包括:
·更多内容 - 建立帮助文件不过是概念和/或其他内容项目(没有API内容)的基础上。
·其他参考链接 - 添加额外的引用链接的第三方库或MSDN的内容不会出现在您的帮助文件。
·AjaxDoc生成器 - 建立结合AjaxDoc Atlas脚本库中的帮助文件。
·完成通知 - E-mail的结果的人可以选择安装日志文件(原材料或通过XSL转换)。
·的DBCS修正为构建 - 修复CHM HTML内容和运行编译器在正确的语言环境,以克服其编码的问题的说明1。
·层次结构表的内容 - 用来重新排列他们的父命名空间的命名空间嵌套在表中的内容。
·输出部署 - 得到的帮助文件复制到一个文件共享,Web服务器,FTP站点,等等。
·脚本#反射文件定影液 - 修正了反射使脚本#程序集信息文件被正确记录。
·表的内容排除 - ,用于排除API成员(成员仍然会出现在帮助文件中)从表中的内容。
·版本生成器 - 生成当前项目的版本信息和其他相关的同样的产品,并合并成一个单一的帮助文件,所有的人都该信息。
·插件的接口是公开的,这使您可以创建自己的自定义插件的帮助文件记录。
·支持包括标签,它可以让你继承从基类型/成员的文档。这是通过一个独立的工具,所以它也可以使用其他的第三方工具和构建脚本实现。此工具提供的功能以外的发现在构建组件提供与沙堡。