Lack of comments considered harmful [ Was: Re: [mythtv] C++ style ]

Clyde Stubbs clyde at htsoft.com
Fri Feb 13 03:42:50 EST 2004


On Wed, Feb 11, 2004 at 07:50:46PM +0000, Paul Woodward wrote:
> I am strongly of the view that code should be written primarily to be clear, concise and legible.

I also agree strongly with that - can I use this opportunity to make a plug for the
use of comments? I'm referring in particular to the notion of placing before EVERY
function (or whatever catchy name they're referred to by in C++) a 2 or 3
line comment describing what the function does, any special assumptions it makes
etc.

I've spent quite a bit of time wading through the Myth code trying to
get enough of a handle on it to fix some of the DVB bugs and it would
help ENORMOUSLY if an extra minute was spent doing the above.

</soapbox>

Cheers, Clyde


-- 
Clyde Stubbs                     |            HI-TECH Software
Email: clyde at htsoft.com          |          Phone            Fax
WWW:   http://www.htsoft.com/    | USA: (408) 490 2885  (408) 490 2885
PGP:   finger clyde at htsoft.com   | AUS: +61 7 3552 7777 +61 7 3552 7778
---------------------------------------------------------------------------
HI-TECH C: compiling the real world.


More information about the mythtv-dev mailing list