Hi,
> When you add a (relatively) cryptic block of code like that, a simple comment
> (like was included in your commit message) speaks volumes. Even just a
> simple /* delete duplicated points */ is warranted there and would be helpful.
> To everyone, you'll quickly notice HUGE variation throughout the code. Some
> portions are heavily commented. Others (like the *_brep() functions) are
> *not* or very poorly commented. It goes with the territory when you build up
> 1M+ lines over decades. That's all the more reason to "clean up as you go".
> As you read and understand what a block of code is doing, feel free to add a
> little comment that might help the next person.
> Don't state the obvious like variable names and looping constructs. Annotate
> logically what the code doesn't say, summarize how, explain why. Add what
> would have helped you. Clean up as you go.
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().
Cheers!
Wu Jianbang
------------------------------------------------------------------------------
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
