Documentation generator for C# projects

Posted on August 5, 2007

Ever noticed lack of .net documentation on the net?

There are plenty of javadoc but nothing for C#. That’s because Microsoft never provided documentation generator for .Net and open source projects are currently in non-working state. Well that is changing; Microsoft is trying to fill the need for various tools. They now have Sandcastle for documentation generation and msbuild for build scripting. I tried them and basically they suck and I will never use them.

However I found great open source tool for documentation generation, I think many Concordia CS students are familiar with it already, it’s called Doxygen.

With Sandcastle it took me about an hour to figure out how to make it work, but with docgen it only took 15 seconds! Doxygen produces amazingly useful and nicely formatted documentation. It event generated some graphs!

For the build scripting I have to use nant and msbuild together. I fork msbuild to build the project and use nant for everything else.
—————–

Why Microsoft had to design such and ugly XML for their tools?

© Copyright 0xDEADBEEFCAFE • Powered by Wordpress • Design by Sebastin.