NDoc文档工具
-
NDoc 文档工具可以将 C#.NET 语言进行编译,并且生成程序集和对应的/doc XML 文档,还可以自动转换成如 .NET Framework SDK 类库文档、 MSDN Library 在线 .NET 类库文档等形式的代码文档,让程序猿们能够拥有快速并且专业级的类库API 文档。
NDoc工具通过使用反射来分析程序集,并且使用了从 C# XML 注释生成的 XML然后自动为代码生成文档资料。XML 注释仅适用于 C#语言,但有一个被称为 VBCommenter 的 Visual Studio .NET Power Toy,它能够使 Visual Basic .NET 完成与之类似的工作。此外,下一版本的 Visual Studio 将能够为更多语言支持 XML 注释。
在使用 NDoc工具时,你仍然可以在编写代码的技术文档,但你是在编写代码的过程中就已经完成了文档编写工作,而这更容易被接受。使用 NDoc 工具时,第一步是先为你的程序集打开 XML 注释生成功能,就会自动生成xml注释。然后右键单击该项目并选择 Properties | Configuration Properties | Build选项,然后在 XML Documentation File 选项中输入一个路径用来保存 XML 文件。当该项目生成时,将自动创建一个 XML 文件,该文件中自动包含所有 XML 注释。
NDoc工具考察到你的程序集之后会读取该文档中的 XML,并且将它们进行逐个匹配。NDoc工具使用该数据来创建一个或者多个不同的文档格式,包括会创建 HTML帮助文件。在生成XML 文件之后,下一步是将程序集和 XML 注释文件加载到 NDoc工具 中,以便可以对它们进行处理。并且可以通过打开 NDoc 工具并单击 Add 按钮,可以容易地完成该工作。
西南地区IT社群(QQ)
- 云南
- 【昆明网页设计交流吧】243627302
- 【昆明nodejs交流吧】 243626749
- 【VUE】838405306
- 【云南程序员总群】343606807
- 【昆明UI设计】104031254
- 【云南软件外包】15547313
- 贵州
- 【PHP/java源码/站长交流群】55692114
- 四川
- 【成都Java/JavaWeb交流】86669225
- 【vaScript+PHP+MySql】116270060
- 【UI设计/设计交流学习群】135794928
- 重庆
- 【诺基亚 JAVA游戏博物馆】 559479780
- 【PHP,Java,Python,C++接单】 442103442
- 西藏