NDoc 用户指南(一)

最新推荐文章于 2024-07-30 10:47:01 发布

weishaolin131083

最新推荐文章于 2024-07-30 10:47:01 发布

阅读量2.8k

点赞数

分类专栏： B0.▲ C# 文章标签：文档 microsoft 引擎 xml .net html

本文链接：https://blog.csdn.net/weishaolin131083/article/details/6332377

版权

NDoc 是一个开源工具，能够将 C#.NET 程序集和 XML 文档转换为专业级的代码文档，支持多种文档引擎，如 HTML Help 1、Microsoft Help 2、Markdown 等。新版本 NDoc 1.3 引入了性能提升、新的标记支持、错误处理改进和扩展性增强。用户可以通过 GUI 界面或命令行工具配置项目，包括选择文档引擎、设置输出过滤、自定义标记等。此外，NDoc 还支持排除不需要的类型或成员，以及处理非英文字符。用户需要注意文件名长度限制和大小写敏感问题，以及准备必要的工具如 HTML Help Compiler 和 LaTeX 编译器。

摘要由CSDN通过智能技术生成

关于 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 Licence 和 GNU FAQ。

请阅读已知问题。

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

NDoc 各本地化版本
英文版: NDoc in English
简体中文版: NDoc in Simplified Chinese
德文版: NDoc in German
日文版: NDoc in Japanese
(此列表可能并不完整。欢迎大家给我发送更多关于 NDoc 的本地化版本的网址！)

关于中文版
此 NDoc 1.3 (中文版) 由破宝(percyboy) 翻译，遵循 GPL 协议