NDoc 命令行工具

概述

NDoc 不仅提供了 GUI 的界面，也同时提供了命令行工具(NDocConsole.exe)，为和其他开发工具集成提供了方便。

语法

NDoc 命令行使用简单的“name-value 对”语法来指定相应的配置项。每个选项前用一个短线，如：-name=value，短线和等号周围不要有空格。下面语法叙述中，中括号的部分是可选的。路径中如果包含有空格，则需要用引号(")括起来。

用法 1

 NDocConsole  程序集[,XML文档] [程序集[,XML文档]]...
              [[-referencepath=文件夹] [-referencepath=文件夹]...]
              [-namespacesummaries=文件名]
              [-documenter=文档引擎]
              [[-引擎参数=值] [-引擎参数=值]...]
              [-verbose]

注释:

程序集: 要生成文档的完整路径。
XML文档: 对应的 XML 文档（C# 编译器 /doc 输出的 XML 文档）。
缺省时，将自动查找和程序集相同路径、相同名称，仅扩展名不同(.xml)的 XML 文件代替。
referencepath: 引用的第三方 dll 的搜索路径。
namespacesummaries: 要使用的命名空间摘要 XML 文档的完整路径。
documenter: 要使用的文档引擎的名称。注意此项区分大小写。
缺省时，将使用 MSDN 文档引擎。
引擎参数: 文档引擎的配置参数名称，注意此项区分大小写。
值: 给引擎参数设置的值。
verbose: 显示文档生成进度的输出消息。

用法 2

 NDocConsole  -recurse=文件夹[,最大读取深度]
              [[-referencepath=文件夹] [-referencepath=文件夹]...]
              [-namespacesummaries=文件名]
              [-documenter=文档引擎]
              [[-引擎参数=值] [-引擎参数=值]...]
              [-verbose]

注释:

recurse: 您可以将要生成文档的程序集和它们对应的 XML 文档放在同一文件夹中（注意：XML 文档的文件名应和对应的程序集文件名相同，仅扩展名不同），将此文件夹指定给此参数，NDoc 将自动查找程序集和 XML 文档。这是一种比较简单的用法。
最大读取深度: 在 recurse 参数指定的文件夹中的读取深度。
referencepath: 引用的第三方 dll 的搜索路径。
namespacesummaries要使用的命名空间摘要 XML 文档的完整路径。
documenter: 要使用的文档引擎的名称。注意此项区分大小写。
缺省时，将使用 MSDN 文档引擎。
引擎参数: 文档引擎的配置参数名称，注意此项区分大小写。
值: 给引擎参数设置的值。
verbose: 显示文档生成进度的输出消息。

用法 3

  NDocConsole  [-documenter=文档引擎] -project=NDOC项目文件 [-verbose]

注释:

documenter: 要使用的文档引擎的名称。注意此项区分大小写。
缺省时，将使用 MSDN 文档引擎。
project: 您可以使用 NDoc GUI 界面保存一个 NDoc 项目文件，然后设置给此参数。
verbose: 显示文档生成进度的输出消息。

用法 4

NDocConsole  [-help] [文档引擎 [引擎参数]]

where:

help: 显示命令行帮助信息。
如果文档引擎参数没有指定，显示 NDoc 命令行的基本语法。
文档引擎: 显示此文档引擎的帮助信息（如：可用的配置参数项等）。注意此项区分大小写。
如果引擎参数没有指定，显示此文档引擎可用的配置参数列表。
引擎参数: 显示文档引擎的某配置参数的信息，如描述、默认值。若参数为枚举类型，还会列出可用的枚举值（使用时注意区分大小写）。

可用的文档引擎

NDoc 1.3 自带的文档引擎包括: JavaDoc, LaTeX, LinearHtml, MSDN, MSDN_2003, VS.NET_2003, 以及 XML。

您可以使用 NDocConsole -help 看到实际的列表。

命名空间摘要 XML 文档的语法

<namespaces>
	<namespace name="My.NameSpace">My summary.</namespace>
	<namespace name="My.OtherNameSpace">My other summary.</namespace>
	...
</namespaces>