NDoc 用户指南   [回目录] NDoc 1.3

NDoc 开发者参考

[此文档为预发布版本,在未来版本中有可能改变。]

实现一个新的文档引擎

实现一个新的文档引擎至少需要编写两个类:

DocumenterConfigBase 是用于存储文档引擎配置信息的基类。它已经包含了一些通用的配置项,这些通用配置主要用于配置 NDoc 中间 XML 数据文件的生成动作。您编写的子类可以添加所需要的特定配置项(比如生成的文档保存在什么路径下等)。

DocumenterBase 是文档引擎的基类。文档引擎的工作模式是,第一步生成 NDoc 中间 XML 数据文件,第二步由各文档引擎将中间 XML 数据文件、分别转换成所需的最终文档格式。此基类完成了第一步的工作,您编写的子类只需完成第二个步骤。

必须实现的成员包括 Clear, Build 方法以及 MainOutputFile 属性等抽象(abstract)成员。

实现 Build 方法时, 可以调用基类的 MergeXML 方法,它完成第一步的 NDoc 中间 XML 数据文件的合并和制作。

使用 XML 文档引擎 可以导出一个 NDoc 中间 XML 数据文件的样例。您可以通过分析它,调试您的自定义转换代码或 XSLT 转换定义。使用 UseNDocXmlFile 配置项,可以节省您的调试时间。

文档引擎是如何加载的

NDoc 通过反射发出(Reflection)机制动态分析和加载文档引擎。NDoc 启动时,自动检查程序(NDocGui.exe 或 NDocConsole.exe)所在路径中、所有以如下格式命名的程序集:

    NDoc.Documenter.<NAME>.dll

其中 <NAME> 是文档引擎的名称(注: 可能与界面中显示的名称不同)。

NDoc 从这些程序集中分析、尝试查找 DocumenterBase 的子类,并加载找到的文档引擎。