On several occasions a monk who we all think highly of, let me know
that good code comments itself. If you choose the names of variables
and functions carefully, their function in the program becomes clear
without separate comments.
Yeah, I've heard that before too. K&P write that too. And it's certainly
true that well written code needs less comments. It avoids micro comments,
of the style "add one to the number of elements". However, in general
well choosen names of variables don't explain *why* certain actions are
taken. At best they tell us what is going on. And usually, they don't
tell enough of the global picture, an entire block or function. Names
alone don't tell us why statements have to be done in a certain order -
they don't show pre- or post conditions.
I know only one program of substantial size that's commented only sparsely,
and that's perl. But I've never heard that code is easy to grasp...
Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
Read Where should I post X? if you're not absolutely sure you're posting in the right place.
Please read these before you post! —
Posts may use any of the Perl Monks Approved HTML tags:
Outside of code tags, you may need to use entities for some characters:
- a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.
| & || & |
| < || < |
| > || > |
| [ || [ |
| ] || ] ||