If you've formatted your comments in a compatible way, doxygen does a fantastic job. It'll even draw inheritance diagrams if you've got graphviz installed.
For example, running doxygen over the following:
///
/// A summary of my class
///
public class MyClass
{
protected:
int m_numOfWidgets; /// Keeps track of the number of widgets stored
public:
///
/// Constructor for the class.
///
/// Specifies how many widgets to start with
MyClass(int numOfWidgets)
{
m_numOfWidgets = numOfWidgets;
}
///
/// Increments the number of widgets stored by the amount supplied.
///
/// Specifies how many widgets to start with
/// The number of widgets stored
IncreaseWidgets(int numOfWidgetsToAdd)
{
m_numOfWidgets += numOfWidgets;
return m_numOfWidgets;
}
};
Will turn all those comments into entries in .html files. With more complicated designs, the result is even more beneficial - often much easier than trying to browse through the source.
