Hi all,

I think also having some kind of design documentation using UML would be a good thing to get an overview of modules etc. StarUML seems to be a pretty good tool for this purpose, and it is free. I haven’t had time to look into it that much but it seems pretty versatile.

One thing which is always difficult when you come to a new project is to see how modules are connected getting an overview of the whole project. By just reading source files gives you just a microscopic view of a particular part of the solution.

Best regards
anders

…

Bob wrote:

Hi everyone,

These days I am reading the source code of Calitko, I found there are very little comments in the source code, especially for the methods of classes. As Calitko is getting bigger and bigger, the code will become harder and harder to understand.
I would be better that we write some comments for methods and also for members of classes. It would be easier to let the new comers to understand the source code and the authors will not forget the original purposes of the class.
I would like to suggest, we use a templet for all the functions.

What do you think?:)

Bo

/*
* Parameters:
* packet:
*
* Return:
* void
*
* Purpose:
* Notify the other classes, who are interested in the packets.
*
* Scenario:
* One example of the calling procedure.
*/