Beefy Boxes and Bandwidth Generously Provided by pair Networks
Welcome to the Monastery
 
PerlMonks  

Re: Ways of commenting subroutines

by Lexicon (Chaplain)
on Mar 29, 2001 at 05:50 UTC ( #68026=note: print w/ replies, xml ) Need Help??


in reply to Ways of commenting subroutines

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; }
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

Replies are listed 'Best First'.
watch you're speling
by grinder (Bishop) on Mar 30, 2001 at 15:56 UTC

    ouch! you just hit on one of my pet peeves... bad spelling.

    It's "occurrence", not "occurance". Your code may be the greatest thing in the world since sliced bread, but if routine names contain spelling mistakes people are going to believe that the code contains other shoddinesses, thus you wind up needlessly damaging your reputation.

    Worse, client programmers using your code are going to stumble and trip, because they're going to try and call count_occurrences and fail miserably.


    --
    g r i n d e r

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://68026]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others making s'mores by the fire in the courtyard of the Monastery: (2)
As of 2016-07-30 07:46 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    What is your favorite alternate name for a (specific) keyboard key?


















    Results (265 votes). Check out past polls.