Thursday, July 22, 2010

C# Comments and Doxygen

Similar to Java, you can comment your code using special mark-ups, however, unlike Java, you need to source your own tool similar to javadoc to covert these comments into document pages. There are plenty of such tools for Windows, but for Linux, may I recommend doxygen to you. It is an open source documentation tool for a variety of programming languages, e.g. Java, C/C++/C#, php etc, and it is available through the APT package manager under Ubuntu. You can installed it by running

sudo aptitude install doxygen-gui


This would install the doxygen command line utility plus doxywizard, its graphical tool. To run the wizard, you run doxywizard in a command prompt, and after, you simply follow the simple step by step instructions. Presto, you have a well made documentation in minutes!

No comments: