COM 类型库的自动 HTMLHelp 文档






4.79/5 (25投票s)
一个自动生成 COM 类型库 HTMLHelp 文档的工具。然后,您可以为您的方法添加解释和示例源代码。
描述
类型库文档工具 (DocLibTool) 是一个 VB6 程序,它可以帮助您以 HTML Help 格式记录 Microsoft COM 类型库(以及在类型库中描述的任何 COM 组件)。 它在一家公司工作时创建,以帮助我为一些大型 COM 对象创建文档。 来自类型库的信息是使用 TLBINF32.DLL 中实现的 TypeLib Information 组件的函数提取的。 阅读 MSDN 杂志文章 Visual Basic: 使用 TypeLib 信息对象库检查 COM 组件 以获取有关此组件的详细信息。
该程序的基本用法很简单。 您必须提供一个包含由任何支持 COM 的语言(VC++、VB、Delphi 等)创建的类型库 (*.EXE, *.DLL, *.TLB) 的源文件,指向一个将放置所有输出文件的目录,然后按“生成文件”按钮。 程序将创建一个 HTML 文件集,描述类型库(对象、接口、方法、枚举)、一个以结构化方式包含所有信息的 XML 文件、一个 HTML Help 项目文件 (.HHP)、一个 HTML Help 内容文件 (.HHC)、一个 HTML Help 索引文件 (.HHK)。 要编译帮助文件(.CHM 扩展名),请使用 Microsoft 的 HTMLHelp 程序打开 HTML Help 项目文件,然后按“编译”按钮。 如果您没有 HTMLHelp 工具,您可以从 Microsoft 的 MSDN 站点免费下载它(搜索“HTMLHelp”,您就会找到它)。
您可以通过编辑 XML 文件并填写为此目的存在的空标签,将您自己的自定义信息添加到帮助文件中:CoClassDescription、InterfaceDescription、MemberDescription、ReturnValueDescription、ParameterDescription、ExampleCode、Related、EnumerationDescription。 该程序还有一个可视化编辑器,允许您轻松地为方法输入附加信息(一般描述、参数/返回值描述、示例源代码)。 编辑器将此信息保存在 XML 文件中。 您还可以使用 Microsoft HTMLHelp 工具编辑内容文件和索引文件。 最后,您还可以通过编辑 XSL 文件来更改 HTML 文件的格式及其结构(更困难!)。 当您重新生成文件(例如,由于类型库的更改)时,您在 XML 中输入的所有自定义信息都将从旧文件复制到新文件。 如果您在内容或索引文件中添加了条目,它们也将被保留。 每个项目的信息都存储在一个扩展名为 .dlt 的配置文件中。 文件的格式与 INI 文件的格式相同。
如何增强该工具
从类型库中提取的信息保存在 XML 文件中。 XSL 转换(使用一些 Microsoft VBscript 代码扩展)用于创建输出文件(HTML 等)。 如果您想改进该工具生成的文档,您可以编辑它使用的以下文件。 这些文件是
文件名 |
描述 |
TemplateOfTypeLibInfo.xml | 定义生成的描述 XML 文件的结构。 除非您也可以对 VB 代码进行必要的更改,否则不要编辑它。 |
TemplateOfTLBParts.XSL | 此 XSL 文件包含 HTML 文件、HHC 文件和 HHK 文件的模板。 您可以编辑它以自定义 HTML 文件的外观。 |
scripts.xsl | 包含用于实现超出 XSL 样式表命令功能的任务的 VBScript 代码(例如,将 XML 片段保存在磁盘中)。 它包含的函数由 TemplateOfTLBParts.XSL 调用。 最好不要修改任何函数。 |
ie4.css | HTML 文件中使用的样式 |
历史
- 2003 年 1 月 13 日 - 添加安装下载
- 2003 年 3 月 7 日 - 更新安装下载