Now you are describing a very specific situation, which is a far cry from your earlier "everyone will use inline POD if the syntax gets changed".

I don't think it was me saying that, but never mind.

The "specific situation" is one that I encounter every day: I author and maintain a number of programs/applications written in Perl. I put common stuff into general CPAN-style modules, but the actual program functionality is always a number of very domain specific classes whose interface needs to be documented. For that I use POD which I think works fine, especially since I also use a POD/module browser that will jump me right into the source when I need that.

Writing CPAN modules is another "specific sitation", although a more common one for some people.

Again -- the interface needs to be documented, the usage too. The interface should be documented near the implementation, hence inline POD. The usage should be described and explained. EOF or BOF POD is perhaps more natural in this case.

The issue of where to place POD (if that's what you like best) is maybe not "either-or", rather "both", since both are needed.

New revised personal preference :)

/J

In reply to Re: Re: Re: Inline POD vs. EOF POD by jplindstrom
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, 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.