AzamSharp

Creating Code Documentation Using XML Comments and XSLT
published on 6/8/2008 8:03:44 PM

Today, I had to create documentation for my existing code so I was searching for some good free tools. NDoc was the first tool that came to my mind but unfortunately, that project is dead. Next tool was SandCastle by Microsoft. Unfortunately, this tool was taken off line from Code Plex because of some open source issues.

So, now the option was to spend few hours online searching for the right tool or to implement a simple lame version myself. I took the later approach and came up with the following tool. I call it Lame Documentation Builder since the documentation created is pretty lame.

You can implement the application as a command line tool but I made is to run as Windows Application since it will be much easier for junior developers. Below you can see the interface of the Lame Documentation Builder.

And here is the generated output (The generated file is an HTML file):

You can download the project using the link below:

[Download Sample]

Did you like this article?

Submit

by Arjan Zuidhof on 6/9/2008 12:00:48 AM
Whoa, Sandcastle offline! You could still download the October CTP if you want here http://www.microsoft.com/downloads/info.aspx?na=22&p=1&SrcDisplayLang=en&SrcCategoryId=&SrcFamilyId=&u=%2fdownloads%2fdetails.aspx%3fFamilyID%3de82ea71d-da89-42ee-a715-696e3a4873b2%26DisplayLang%3den
It's really a cool tool you know, MSDN technical documentation is created internally by Microsoft. Let's hope the thing comes back quickly. Btw, there is a temp link to the May CTP on the Sandcastle blog, don't know how long that will last thought

Name:
Name:
Email:
Comment/Feedback:
2+2=