首先,您应该确认,您已经打开了 C# 项目的 /doc 开关,当 Visual Studio .NET 编译时,每次都会生成相应的 XML 文档。
如果没有特殊情况,请让项目输出的程序集名称和 XML 文档文件名、仅仅扩展名不同(比如程序集是 NDoc.Test.dll/NDoc.Test.exe,XML 文档是 NDoc.Test.xml)。在 NDoc 中,当您加入某程序集时,NDoc 会自动查找这样的“同名” XML 文件。如果找到,就会尝试自动将它当作该程序集的 XML 文档。这样会简化您的操作。
打开项目的“属性”对话框,
找到程序集名称
设置 XML 文档文件为程序集名称(扩展名改为 xml)。别忘了设置此项之前,选择“所有配置”,让 Debug 或 Release 配置下,都自动生成 XML 文档。
设置 XML 文档文件配置
现在,每次使用 VS.NET 编译您的程序集,都会自动从源代码中提取所有的 XML 注释,生成 XML 文档文件。
如果您使用的不是 Visual Studio .NET,您同样应该尝试打开 C# 编译器的 /doc 选项。
NDoc development is hosted by
|
![]() |