Personally I comment when I think it needs a comment :-)
My commenting style has gone from none (long, long ago when I was young and innocent), to far too much (after the first few times I had to maintain somebody else's code :-), to what is hopefully a happy medium.
I've noticed in recent years that things I would have previously elucidated with a comment I now explain in other ways. For example:
- I write a lot of tests.
- I spend a lot more time and effort on the naming of variables and methods.
- I spend a lot more time refactoring code for clarity and ease of understanding (as opposed to functionality or efficiency).
- I use assertions, preconditions, postconditions and other design by contract techniques.
These have an advantage over textual comments because (apart from naming) they cannot get out of sync with the code base.
-
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.
|
