I'd say the inline version is more likely to be maintained
because the "commute time" between the function and
the associated documentation is much shorter. If things
are on the same screen, even the lazy are inclined to
keep things in sync. If it's at some obscure location in
the file, things might drift apart.
BTW, here's a quick macro for 'vi' for skipping to the
POD documentation in a file:
You could make this into an alias, such as 'vipod'. When
it enters each file it runs the command to find the first
line that begins with '=pod'. If you don't always use
that tag, you can just search for the equals sign.
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:
You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
- 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
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.
| & || & |
| < || < |
| > || > |
| [ || [ |
| ] || ] ||