Beefy Boxes and Bandwidth Generously Provided by pair Networks
We don't bite newbies here... much
 
PerlMonks  

Comment on

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

I was having a hard time understanding how to use POD documentation when I was habitually using block comments for all my documentation purposes. After reading the Perl Programming Documentation about POD, I found that, where I usually used comment blocks to describe functions, POD is just as effective if not more so. I then wondered, what is the purpose of commenting when POD exists (besides TMTOWTDI). I then realized that I should document my functions using POD and make small notes about the actual code using comments.

For example:

=pod =head2 mySubroutine Takes no argument. This is a sample example to show my idea about documentation using both comments and POD. =cut sub mySubroutine { print 'This is a sample subroutine.', "\n"; # prints this text because it's a simple example. } mySubroutine();

I hope this helps anyone who is just discovered POD and is either now confused about the purpose of both comments and POD or is looking for another method of documenting their code. If anyone has any comments (ha, comments), suggestions, or corrections for this node, please let me know!

Disclaimer:
This is what works for me, and, as always, TMTOWTDI.

"It's funny, the claw isn't what you should be worried about" -The Raven

In reply to Documentation: POD vs Comments by ravenclaw

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!
  • 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
  • Outside of code tags, you may need to use entities for some characters:
            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?
    and the web crawler heard nothing...

    How do I use this? | Other CB clients
    Other Users?
    Others avoiding work at the Monastery: (6)
    As of 2014-09-22 22:38 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?

      How do you remember the number of days in each month?











      Results (206 votes), past polls