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...
-- Abigail
-
Are you posting in the right place? Check out Where do I post X? to know for sure.
-
Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
<code> <a> <b> <big>
<blockquote> <br /> <dd>
<dl> <dt> <em> <font>
<h1> <h2> <h3> <h4>
<h5> <h6> <hr /> <i>
<li> <nbsp> <ol> <p>
<small> <strike> <strong>
<sub> <sup> <table>
<td> <th> <tr> <tt>
<u> <ul>
-
Snippets of code should be wrapped in
<code> tags not
<pre> tags. In fact, <pre>
tags should generally be avoided. If they must
be used, extreme care should be
taken to ensure that their contents do not
have long lines (<70 chars), in order to prevent
horizontal scrolling (and possible janitor
intervention).
-
Want more info? How to link
or How to display code and escape characters
are good places to start.
|
