作者:James Avery 翻译:lucentoff
出处:http://msdn.microsoft.com/msdnmag/issues/04/07/MustHaveTools/default.aspx
声明:版权属原作者所有,转载请注明出处!
NDoc
<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />
编写代码文档一直是一项令人生畏的任务。这里我并不是指设计初期的文档或更为详细的设计文档,而是指类中方法和属性的文档。NDoc工具能使用反射检查程序集并使用从C# XML注释生成的XML文档自动为你的代码生成文档。目前只有C#提供XML注释,但利用Visual Studio .NET小工具VB Commenter 可以使Visual Basic .NET具有XML注释功能。另外,Visual Studio的下一个发布版本将对更多的语言支持XML注释。
利用NDoc,你很容易在编写代码的同时形成文档(在XML注释中)。要使用NDoc,首先要在Visual Studio.NET中打开程序集的XML注释生成功能。右键点击项目,选择Properties | Configuration Properties | Build ,然后在“XML Documentation File”项中输入保存XML文件的路径。当项目编译时,就会创建一个包括所有XML注释的XML文件。下面是NUnit范例中一个方法的XML文档:
/// <summary><p></p></summary>
/// This test adds a number of values to the Hashtable collection
/// and then retrieves those values and checks if they match.
///
[Test]
public void HashtableAddTest()
{
//Method Body Here
}
该方法的XML文档将被抽取并保存到XML文件中,如下所示:
<member name="M:NUnitExample.HashtableTest.HashtableAddTest"><p></p></member>
<summary>This test adds a number of values to the Hashtable collection<p></p></summary>
and then retrieves those values and checks if they match.
NDoc利用反射查看程序集,然后读取文档中的XML并进行匹配。NDoc可使用该数据创建各种不同的文档格式,包括MSDN风格的HTML帮助文件格式(.chm)、Visual Studio .NET 帮助文件格式(HTML Help 2)等。生成XML文件之后,下一步是将程序集和XML文件加载到NDoc中以便进行处理。操作很简单,只需打开NDoc并点击“Add”按钮,然后添加相关文件即可。
一旦程序集和XML文件载入NDoc中并根据属性范围定制输出后,点击“Generate”按钮就开始生成文档。使用默认属性,NDoc会生成一些非常有用的.html和.chm文件,因而以快速和有效的方式自动完成了烦人的任务。
分享到:
相关推荐
ndoc,文档自动生成工具,支持.net 2.0
.Net十大必备工具 1. Snippet Compiler Snippet Compiler 是一个基于 Windows 的应用程序,可以通过它来编写、编译和运行代码。如果具有较小的代码段,并且不希望为其创建完整的Visual Studio .NET项目(及伴随该...
精心收藏的支持.net 2.0和中文的Ndoc.可以将C#.NET 编译生成的程序集和对应的/doc XML 文档,自动转换成如.NET Framework SDK 类库文档或者MSDN Library 在线.NET 类库文档形式的代码文档,让您快速拥有专业级的类库...
两个不同的转换器工具,ASP.NET 版本转换器(Version Switcher)和 Visual Studio .NET 项目转换器(Project Converter) Regulator:生成正则表达式工具 .NET Reflector:程序集分析检查工具 注:还有一个工具由于...
XML 注释仅适用于 C#,但有一个名为 VBCommenter 的 Visual Studio .NET Power Toy,它能够为 Visual Basic .NET 完成类似的工作。此外,下一版本的 Visual Studio 将为更多语言支持 XML 注释。
Ndoc .net 的类库文档生成工具(支持.net 2.0)
.Net十大必备工具 1. Snippet Compiler Snippet Compiler 是一个基于 Windows 的应用程序,可以通过它来编写、编译和运行代码。如果具有较小的代码段,并且不希望为其创建完整的Visual Studio .NET项目(及伴随该...
两个不同的转换器工具,ASP.NET 版本转换器(Version Switcher)和 Visual Studio .NET 项目转换器(Project Converter) Regulator:生成正则表达式工具 .NET Reflector:程序集分析检查工具 注:还有一个工具由于...
NDoc 是一款不错的开源的自动文档生成工具,可是因其只能支持.net1.1所以其更新速度已经不能满足现在已经很普及的.net2.0、.net3.0。现在我修改了一下这个程序,让其支持.net2.0, 下载后使用vs2005或vs2008打开生成...
.net平台下文档生成工具 NDOC 根据注释生成文明文档
• NUnit:编写单元测试的工具 工具下载地址:http://www.vckbase.com/tools/viewtools.asp?id=175<br>• NDoc:创建代码文档的工具 • NAnt:生成解决方案的工具 • CodeSmith:代码生成工具 • ...
NDoc 1.3.1,目前的最新版本,支持.net Framwork 2.0,中文+绿色版
NDOC 1.3 For .NET 2.0 很好用的工具!倾力为大家奉献!希望多大家有用!
编写单元测试的工具 NDoc:创建代码文档的工具 NAnt:生成解决方案的工具 CodeSmith:代码生成工具 FxCop:用于监视代码的——代码警察 Snippet Compiler:小型代码段编译工具 两个不同的...
C#中XML格式的文档注释好处多多:Visual Studio会在很多地方显示这些注释内容(例如,编辑器的工具提示或对象浏览器),还有一些工具(比如NDoc或微软的文档工具Sandcastle) 也可以利用这些注释生成具有良好外观的...
两个不同的转换器工具,ASP.NET 版本转换器(Version Switcher)和 Visual Studio .NET 项目转换器(Project Converter) Regulator:生成正则表达式工具 .NET Reflector:程序集分析检查工具 并负载最新...
描述:这是一个WebLog形式的在线日志网站,定期更新,包括.NET相关的工具、混淆器、反编译器等各种信息,十分值得收藏。 名称: 地址:http://www.aspalliance.com/aldotnet/examples/translate.aspx 描述:c#...
c#文档生成工具 .net必备工具 UI界面,很强大
NDoc 可以将 C#.NET 编译生成的程序集和对应的 /doc XML 文档,自动转换成如 .NET Framework SDK 类库文档或者 MSDN Library 在线 .NET 类库文档形式的代码文档,让您快速拥有专业级的类库API 文档。(VB.NET 通过第...
NDoc,C#.NETxmltoDOC