By sebastien venot (17. November 2006, 18:52:48)
Re: Re: About comments in the source code
 (1 )

Hi

Yes comments is more than needed it is mandatory. There is otherwise no way for a new developer to join a project, or it would requires a lot of time to get into the coding.

A good way to force writing comments is to configure IDE like Eclipse to generate errors if methods does not have a proper comment on the top of it. I know it is possible in Java with JavaDoc  tags, should be possible in C++ as well?

and as a rule a thumb, more comments is always better than not enough, and never think like: why comment? what i wrote is obvious.
Graphical documentation like UML would help  even more or some  diagram to show the actual exchange of packets in Gnutella (using Calitko object involved) …

regards

sebastien

Would you like to post a relpy?


This post is a reply to:
By Peter Dimov (15. November 2006, 22:19:18)
Re: About comments in the source code
 (2)
Hi Bob, That’s a nice suggestion! Actually we already do something in this respect. It is true some parts of the code are not documented and the reason for that is (more...)

Follow-ups:
By Peter Dimov (17. November 2006, 19:37:07)
Re: Re: Re: About comments in the source code
 (0)
Hi Sebastien, I think all agree that comments are very important and that’s the reason why all new code is required to have documentation. I would suggest that all code that (more...)