To state the obvious, I think it's a matter of taste. Clearly, a series of hash marks in the middle of a function is obnoxious. I personally find hash marks as delimiters of sections of code to be eyesores also. If you're working with a file that's thousands of lines long, and you're breaking it up with comments, maybe you should be breaking it up into separate files. Even in a small file, I practically never scan through it in such a way that obvious breaks would be useful to me. I'm constantly searching (C-s in Emacs!) for what I'm looking for.
What I'd suggest is just to make yourself as consistent as possible. That way some maintenance programmer down the road will have an easy time reformatting your comments to taste. If your comments that I can't stand are regular enough, then I can probably take care of that in just a few minutes.
-
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.
|
