编写代码文档资料ndoc1.3

时间:2012-11-05 05:32:50
【文件属性】:

文件名称:编写代码文档资料ndoc1.3

文件大小:297KB

文件格式:RAR

更新时间:2012-11-05 05:32:50

用于生成net文档

编写代码文档资料几乎总是一项令人畏惧的任务。我所说的不是早期设计文档,甚至也不是更为详细的设计文档;我说的是记录类上的各个方法和属性。NDoc 工具能够使用反射来分析程序集,并使用从 C# XML 注释生成的 XML 自动为代码生成文档资料。XML 注释仅适用于 C#,但有一个名为 VBCommenter 的 Visual Studio .NET Power Toy,它能够为 Visual Basic .NET 完成类似的工作。此外,下一版本的 Visual Studio 将为更多语言支持 XML 注释。 使用 NDoc 时,您仍然在编写代码的技术文档,但您是在编写代码的过程中完成了文档编写工作(在 XML 注释中),而这更容易忍受。使用 NDoc 时,第一步是为您的程序集打开 XML 注释生成功能。右键单击该项目并选择 Properties | Configuration Properties | Build,然后在 XML Documentation File 选项中输入用于保存 XML 文件的路径。当该项目生成时,将创建一个 XML 文件,其中包含所有 XML 注释。下面是 NUnit 示例中的一个用 XML 编写了文档的方法:


【文件预览】:
NDOCForNET2013
----NDoc.Documenter.Latex.dll(36KB)
----NDocGui.exe.manifest(461B)
----NDocGui.vshost.exe(6KB)
----NDoc.Documenter.Xml.xml(3KB)
----NDocGui.exe(248KB)
----NDoc.Documenter.JavaDoc.xml(4KB)
----NDoc.Documenter.Xml.dll(16KB)
----NDocGui.xml(25KB)
----NDoc.Documenter.Latex.xml(5KB)
----NDoc.ExtendedUI.dll(28KB)
----NDoc.Documenter.Msdn.dll(324KB)
----NDoc.VisualStudio.xml(8KB)
----NDoc.Core.dll(200KB)
----NDoc.Core.xml(171KB)
----NDoc.VisualStudio.dll(24KB)
----readme.txt(2KB)
----NDoc.Documenter.JavaDoc.dll(76KB)
----Interop.MSHelpCompiler.dll(5KB)
----NDoc.Documenter.NativeHtmlHelp2.dll(448KB)
----NDoc.Documenter.LinearHtml.xml(29KB)
----NDoc.Documenter.LinearHtml.dll(256KB)
----CodePub.Com说明.txt(2KB)
----NDoc.Documenter.NativeHtmlHelp2.xml(76KB)
----NDoc.Documenter.Msdn.xml(26KB)

网友评论