On Thu, 2002-11-21 at 07:05, Benoit Gr�goire wrote: > 6-The GnuCash codebase is very scarcely commented.
> Solutions: > 6-I presume that this comes from a time when Gnucash was developed intensively > by a tight group of people, relying on complete and up to date design > documents. I know some people consider that the code should speak for itself > and comments are a distraction. But someone coming into a new project can't > be expected to know every function name, and to such a person, ANY code is > hard to understand without general comments about what a section of code or a > non trivial function call is expected to do. Obviously we can't go back an > comment the entire codebase, but I think this should be remembered by all > hackers for new or modified code. As Benoit figures, 4 years ago when I first became involved in this project, the core development team had very clearly defined focus for their areas of speciality. Unfortunately, no-one seemed to consider that one day a few years in the future, not one of those people is actively involved in working on (the publicly accessible) Gnucash. Based on this experience, I would like to suggest that such a complete change can and probably will happen again. Although it will make the size of our codebase even larger, I would like to see *every* change committed to CVS to be clearly documented by comments in the code. Over time and in a relatively painless way, we will eventually document the entire codebase. Once this trend gets established, new people joining the team will automatically follow it. If we can tie this in with something like DOxygen or whatever, that is even better. Conrad. -- Conrad Canterford ([EMAIL PROTECTED]) Water Sprite Pty Ltd | url - http://www.watersprite.com.au/ GPO Box 355, | - Australian Tour and Event Management (ATEM) Canberra, ACT 2601 | - Ticketing Division. Mobile: +61 402 697054 | - Catering Services Division. _______________________________________________ gnucash-devel mailing list [EMAIL PROTECTED] http://www.gnucash.org/cgi-bin/mailman/listinfo/gnucash-devel
