Hi!
I recently documented the source code of Mondrian. This means adding class comments and
methods comments.
Before the effort, only 14% of the methods were commented. Below a screenshot of the
DocumentationBlueprint, a visualization intended to help me document. The MOShape class
hierarchy is here presented.
After the effort, 24% of the methods are commented. Here is another screen, after 3 days
of work.
Here is the legend:
'big box = class' .
'edge = inheritance link' .
'small box = method' .
'small box height = number of lines of code' .
'small box width = number of collaborating classes' .
'red border = non commented' .
Comments are welcome
Cheers,
Alexandre
--
_,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:
Alexandre Bergel
http://www.bergel.eu
^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.