On May 22, 2012, at 1:28 AM, phoenix wrote: > As you say, comments are very important in the code we write. I will write > necessary comments in the code I write later to make it clear to the person > who reads it. Although I think the *_brep() functions need not to be heavily > commented because many of steps are quite similar, I will add some comment > summarizing the key steps of the conversion as I did in pipe_brep().
Fewer comments with critical details are generally far more useful than long-winded verbose explanations. No comments, however, are usually very bad coding practice. There's almost always a comment that would be useful for readability without introducing a maintenance cost. A hundred lines of code without a single comment is usually just lazy coding. Cheers! Sean ------------------------------------------------------------------------------ Live Security Virtual Conference Exclusive live event will cover all the ways today's security and threat landscape has changed and how IT managers can respond. Discussions will include endpoint security, mobile security and the latest in malware threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/ _______________________________________________ BRL-CAD Developer mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/brlcad-devel
