Beefy Boxes and Bandwidth Generously Provided by pair Networks
There's more than one way to do things
 
PerlMonks  

Comment on

( #3333=superdoc: print w/replies, xml ) Need Help??

I'm interested in what subroutine commenting practices people use. I'm not interested in figuring out which is the "best", just wonder methods others use...

When I create a module, before each private subroutine I put a comment like so:

## ## user_address() ## ## Arguments: ## $name: string Name of the user ## $phone: string Phone num of user ## ## Returns: string Address of user ## ## Does a database check on the given user and returns ## the address. ## sub user_address { #whatever }

I always use empty parentheses on the top line, just to make it obvious from a glance that this block of comments documents a subroutine.

Also, whenever I have a subroutine that will be called from outside the module, I use POD, like so:

=item population() Arguments: $country: string Country code of country Returns: integer Population of country Given a country, returns the population. =cut sub population { ...

My question: what do you do? I've seen a few varying styles in CPAN documentation... is there one style that you've found particularily useful, and why?

stephen


In reply to 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, 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, 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.
  • Log In?
    Username:
    Password:

    What's my password?
    Create A New User
    Chatterbox?
    [marioroy]: Disciplus My wife and I went on vacation. At work, I was stuck polling SNMP from 20 million devices. It would hang at 80,000. On the mist boat, hear a voice to enable grace in the design that 10x and more performance awaits.
    [Lady_Aleena]: Women need challenges too karlgoethebier. 8)
    [marioroy]: s/hear/heard/
    [karlgoethebier]: Discipulus: No. See https://en. wikipedia.org/ wiki/Tribe_( Native_American)
    [karlgoethebier]: They took Unix from some aliens
    [marioroy]: Perl is so powerful that it can poll 40 metrics from 20 million devices in 40 minutes using 4 nodes only.
    [karlgoethebier]: http://www. uncoveror.com/ aliens.htm
    [Lady_Aleena]: marioroy, I can't decide whether or not to move my RolePlaying:: Random:: modules to just Random::. I'm not as sophisticated as most here.
    [marioroy]: Naming things can be difficult, sometimes more so that the actual code :)
    [karlgoethebier]: Lady_Aleena: You need to jump to some conclusion

    How do I use this? | Other CB clients
    Other Users?
    Others making s'mores by the fire in the courtyard of the Monastery: (9)
    As of 2017-05-29 08:53 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?