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.

In reply to Re: What makes a comment "obnoxious"? by kyle
in thread What makes a comment "obnoxious"? by papidave

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • 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:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, 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, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.