>"its always easier to remove redundant comments than to decipher logic from
>sourcecode."

>I understand it's preference, but sometimes it's taken too far.  When I see
>comments like that I get the sense that the programmer (or should I say
>coder) didn't really feel comfortable with what they were doing.

Those times when I write a program that gets heavily into data manipulation
that takes me a while to figure out, and does some Nifty Things (Yes, yes,
Nifty Things aren't all they're cracked up to be), or uses an algorithm
that takes some understanding (ie Binary Search), I tend to 'write a book'
of comments describing in narrative form exactly what's going on.

My goal is to enlighten the next programmer to work on the program so that
they can -understand- what's happening before they make their changes.

        "I'll just stick my code in right -here-, I guess that's as good a
place as any."

If someone understands what's happening, that 'right place' is more likely
to be the right place!

And, if Murphy has his say, -=I'll=- be the next programmer in about 8
months.  (:

--Paul E Musselman
PaulMmn@ix.netcom.com


+---
| This is the Midrange System Mailing List!
| To submit a new message, send your mail to MIDRANGE-L@midrange.com.
| To subscribe to this list send email to MIDRANGE-L-SUB@midrange.com.
| To unsubscribe from this list send email to MIDRANGE-L-UNSUB@midrange.com.
| Questions should be directed to the list owner/operator: david@midrange.com
+---


This thread ...

Replies:

Follow On AppleNews
Return to Archive home page | Return to MIDRANGE.COM home page

This mailing list archive is Copyright 1997-2019 by midrange.com and David Gibbs as a compilation work. Use of the archive is restricted to research of a business or technical nature. Any other uses are prohibited. Full details are available on our policy page. If you have questions about this, please contact [javascript protected email address].