My current commenting style, although it needs work. You'll have to excuse it's JavaScript-iness, that's all I have handy. 
// ========================================================
//       COUNT OCCURRENCES (
//                          STR, // String to search through
//                          SUB  // String to search for
//                         )
// --------------------------------------------------------
//   Counts the instances of SUB in STR. Counts overlapping 
//     occurrences.  Count_Occurrences( 'rrrrr', 'rr') = 4.
// --------------------------------------------------------
function Count_Occurrences ( STR, SUB ) {
 var last   = 0;
 var count  = 0; 
 while ((last = STR.indexOf(SUB, last + 1)) > -1) { count++ }
 return count;  
}

[download]
Update: If you ever spend a year in a country where they don't speak your language, keep a spell checker handy. Alternatively, if my code is used it will only be by non-english speakers, who wouldn't know how to spell 'occurrence' anyway. ;)

-Lexicon

In reply to Re: Ways of commenting subroutines by Lexicon
in thread Ways of commenting subroutines by stephen

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.