Beefy Boxes and Bandwidth Generously Provided by pair Networks
No such thing as a small change
 
PerlMonks  

Comment on

( #3333=superdoc: print w/replies, xml ) Need Help??
Heh.. you reminded me of the joke:

Yes, I can write with either hand, I'm amphibious!

On a more serious note.. thats an excellent question you bring up, and I'd definitely like to see others opinions on the matter too.

Overall, I personally like inline POD better, from the coders point of view. The fact that it gets the code and documentation close together makes it much easier to keep both up to date. I'll often use POD to document my API's and such, instead of using normal comments. There are a lot of projects out there that readily admit to having poor documentation. With inline POD, there is often no excuse for such behaviour. That would be false laziness, and none of us Perl types would do that, right?? :-)

The problem with POD is that it's darn ugly. I appologize, I don't wish to badmouth it, but it really just is ugly :-) But I find that if you come up with a standard for how to use POD throughout your code to document functions and such, it can get easier to read with practice. Now, others reading your code will have to struggle with it at first.. but IMO, having up to date documentation is worth the added discomfort.
-Eric

In reply to Re: Inline POD vs. EOF POD by andreychek
in thread Inline POD vs. EOF POD by lachoy

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?
    [dazz]: Hi I have grabbed an image from an IP camera with Image::Grab. I then want to pass that image object to a subroutine where I do a read-only test on the image with Image:Magick.
    [dazz]: How do I pass an image object to a subroutine and then apply a Image::Magick a read-only method to the image object???
    [dazz]: Also, I want to use Image::Magick to annotate and composite (not in a sub). How do I take a Image::Grab object and apply Image::Magick write methods to it??

    How do I use this? | Other CB clients
    Other Users?
    Others taking refuge in the Monastery: (7)
    As of 2017-03-27 07:38 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?
      Should Pluto Get Its Planethood Back?



      Results (317 votes). Check out past polls.