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

使用 NDoc 命令行自动生成代码文档

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

配置 NAnt

(暂无)

配置 VS.NET

您可以利用 VS.NET 中提供的生成事件功能,将 NDoc 配置为在每次代码编译完成后、自动生成相应的代码文档。同时 NDoc 代码文档生成将花费不少时间,因此建议您只在 Release 配置状态(或其他自定义的配置状态)时允许自动文档生成。

而 C# 项目的生成事件并不区分各种配置状态(如 Debug 或 Release ),因此需要在生成事件的脚本中添加对配置状态(VS.NET 内置的编译变量)的判断,如:

	if $(ConfigurationName) == Release

因为直接在生成事件窗口中正确书写 NDoc 命令行命令及相关参数、很困难也很容易出现错误,因此您可以将命令写在一个批处理 .bat 文件中,而在项目的生成后事件中引用这个批处理文件(如下图),这样比较容易书写和维护。

Calling a batch file from the post-build event

一个解决方案中有多个项目时,如果您要得到一份整合的代码文档,您可以只在编译顺序中最后的那个项目配置中,填写这个生成后事件命令。如果您想为每个项目单独生成一份文档,则需要分别去配置。您可以根据您的实际情况决定。

关于 NDoc.bat 中的写法,您可以参考下面的命名行(它对应于上面图中的生成后事件命令):

IF NOT %1 == Release GOTO end

"%ProgramFiles%\NDoc 1.3\bin\net\1.1\NDocConsole.exe" -recurse="%2bin\%1"

:end

复杂的解决方案中,可能需要更加复杂的配置,比如有时配置第三方 dll 的搜索路径等,仔细研究一下 NDocConsole.exe -help 的帮助信息吧!

其他开发工具的配置

大多数开发工具都有运行命令行程序的选项,这些开发工具都可以使用 NDoc 命令行来实现代码文档的自动生成。每种开发工具的配置方法可能不同,但思路都很类似上面关于 VS.NET 中的想法。