Code Library

NDoc generates class library documentation from .NET assemblies and the XML documentation files generated by the C# compiler (or with an add-on tool for VB.NET).

NDoc can be directly used by NAnt script to generate class library documentation through a task called .

To make class library documentation NDoc requires XML documentation files generated by Visual Studio.NET when the application is compiled. This is for C# only (the C# Project needs to be configured to generate XML documentation file in VS.NET). The reference of XML documentation file is present in the .csproj file, which is required by task to generate this XML on each compilation.



Setting up NDoc
i Download the latest version of NDoc from http://ndoc.sourceforge.net

ii Install NDoc to D:\citools\ndoc.

It is preferable to get familiar with NDoc before using NAnt’s task to create the documentation. To get started with NDoc refer to http://ndoc.sourceforge.net/usersguide.html.

Source of Information : Enterprise Solution Providers, Inc. 2005 – v1.0