And how is someone reading the script to know what function is defined where?
Pod.
Red flag. You are asking for synchronization of documentation and code, and then further asking for everyone to always keep in mind all of the relevant documentation whenever they produce more code.

If this was an effective solution, then good programmers wouldn't mind lots of global variables and lots of tightly coupled functions. After all, if you can keep track of everything, you can always come up with shorter answers that way.

For more thoughts on why verbose documentation is not a good resolution to programming problems, see the discussion starting at Re (tilly) 2 (disagree): Another commenting question,.

In reply to Re: Re: Re: Re: Lots of subs in large program vs lots of small programs by tilly
in thread Lots of subs in large program vs lots of small programs by bradcathey

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.