Ndoc is a nifty tool to generate documentation for .net projects. It is very easy to install and equally easy to use. Here is what you have to do:
- Download the installer from http://prdownloads.sourceforge.net/ndoc/
- Install the program. You need to have HTML Help installed in you machine. You can download it from http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp
- Start nDoc application.
You can open a new project. There is option of opening a visual studio project as well.
Use add button in Select assemblies to Document section to add assemblies. I did not user Visual studio option and manually added the assemblies I used in my project. - Set properties of documents as you want them. You can change HtmlHelpName property to set the HTML Help Title. I chose the document type to default MSDN.
- Control + Shift + B will build the documentation.
- Viola you have a .chm (Compiled Html File) as well as Web version of Documentation.
Ctrl + shift + V will display it for you.
That’s it fellows. Rest of the time can now be whiled away in writing Blogs :)
