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

.NET 代码文档生成器

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

关于 NDoc

NDoc 可以将 C#.NET 编译生成的程序集和对应的 /doc XML 文档,自动转换成如 .NET Framework SDK 类库文档或者 MSDN Library 在线 .NET 类库文档形式的代码文档,让您快速拥有专业级的类库API 文档。(VB.NET 通过第三方插件如 VBCommenter 的支持,也可以生成 XML 文档。)

NDoc 代码文档的样式包括 HTML Help 1 (即 *.CHM 格式),Microsoft Help 2 (即以形如 ms-help://... 的 URI 地址访问的文档),以及 MSDN 在线网页样式的 .NET Framework 类库文档。

NDoc 为开放源代码项目,采用 GNU General Public Licence 授权协议(除非您的软件/项目也采用 GPL 协议开放源代码,否则您不能在您的软件/项目中使用 NDoc 源代码中的任何部分)。更多的授权问题,请参见 GNU FAQ

感谢您使用我们的软件,也期待着您的参与(建议、BUG 反馈、代码贡献)!

使用 NDoc 之前

请阅读 GNU General Public LicenceGNU FAQ

请阅读 已知问题

请阅读 必要的帮助文件编译器

NDoc 各本地化版本

(此列表可能并不完整。欢迎大家给我发送更多关于 NDoc 的本地化版本的网址!)

关于中文版

此 NDoc 1.3 (中文版) 由 破宝(percyboy) 翻译,遵循 GPL 协议的要求发布源代码。有关中文版的翻译问题和 bug 等,都可以通过我的博客和我联系


此版本的 What's New?