Just wanted to put in that I agree with you. My system is that programs are documented at the end, and libraries are interleaved.

The difference being to me that programs are designed to be used and understood by non-programmers, so the docs often have little or nothing to do with any specific code. Libraries on the other hand are designed to be used by programmers, and each function should be documented on what it does (or, at least, what it is documented to do...) anyway, so the interleaved docs can often serve both purposes: Telling users how to use functions/methods, and telling maintainers what those functions/methods are intended to do.

Otherwise I'd have to write both a comment and documentation, and they'd have to both be maintained in parallel. Interleaving them I only have two things to maintain: the docs and the code.

In reply to Re^3: Perl code - sometimes UGLY... by DStaal
in thread Perl code - sometimes UGLY... by otto

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.