Indeed, that sounds very much like Knuth's literate programming (see Google if you're supremely curious) technique.

Disciplined adherance to this approach guarantees that the documentation and code will always remain in synch. However, it often does require that a separate program separate (heh) the code from the comments before compilation.

POD has certain elements of this (but it's definitely not the same). Javadoc is a little closer.

The only person I've seen who really does this is Andrew Johnson, in Elements of Programming with Perl.

In my opinion, it's more valuable on big projects, but it's a good technique when you're stuck on a problem and need to break it down before you can write code.

In reply to RE: RE: Prgramming vs. Coding by chromatic
in thread Prgramming vs. Coding by extremely

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.