Comments are good. Do not avoid commenting. BUT... as another reply pointed out, comments have to be maintained as well. I like putting in javadoc-style comments, but I've encountered loads of places where it looks like someone has copied and pasted a function and somehow the comment block at the top describes something totally different from the actual procedure. And I will admit that I just left the erroneous comments as they were in most cases. The goal then is for code that is self-documenting and as far as possible only commenting on data structures, on side effects and any assumptions made about incoming data. In the OP's case, I didn't think the example was too bad and I think splitting it up too much could make it look more complicated and scary than it is.
How can you feel when you're made of steel? I am made of steel. I am the Robot Tourist.
Robot Tourist, by Ten Benson
-
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.
|
