NDoc Code Documentation Generator for .NET

<br>

<br>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).

<br>NDoc uses pluggable documenters to generate documentation in several different formats, including the MSDN-style HTML Help format (.chm), the Visual Studio .NET Help format (HTML Help 2), and MSDN-online style web pages.

<br>

<br>If you're new to NDoc, the  Programmer's Reference  provides an example of NDoc's output.

<br>

<br>NDoc's source code is freely available under a certified Open Source license.

<br>

<br>Categories: Documentation - Code commenting

<br>

<br>Latest version: 1.3 Beta 2

<br>

<br>Description: Generates class libraries documentation from .NET assemblies and the XML documentation files generated by the C# compiler (or an add-on tool for VB.NET). NDoc uses add-on documenters to generate documentation in several different formats, including the MSDN-style HTML Help format (.chm), the Visual Studio .NET Help format (HTML Help 2), and MSDN-online style web pages.

<br>

<br>Documenting your code with NDoc  

<br>Since OpenNETCF.org have a lot of experience in building Controls and class libraries to be used by other developers we have a strong awareness of the need for documentation to describe the functionality and limitations of these products. This article will describe a technique for generating HTML based documentation for .NETCF Class libraries which you can use either for internal use or distribute with reusable libraries.

<br>Required:-

<br>NDOC Documenter – This article based around the v1.2 Release

<br>A .NET CF Project (sample project can be downloaded at the end of this article). This article assumes either an Application or Class Library project.

<br>VBCommenter Powertoy(If your project is written in Visual Basic)

<br>NDoc Background

<br>NDoc is an open-source documentation generator for .NET projects. It takes your project output in the form of your dll or exe file and an XML file containing custom documentation added within your code and products MSDN look-alike HTML based help files. The tool uses a mixture of Reflection on your library or executable and the descriptions exported to your XML files to populate this documentation. In C# XML documentation is added by entering three forward-slashes rather than the usual two and following it with xml formatted comments. The tags supported are documented here (link). Visual Studio will help in this process by adding some skeleton tags before your methods when you begin to type “///”.

You could try NDocProc: http://www.lshift.net/~tonyg/ndocproc/doc/index.html