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:
vi '+/^=pod'
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.
-
Are you posting in the right place? Check out Where do I post X? to know for sure.
-
Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
<code> <a> <b> <big>
<blockquote> <br /> <dd>
<dl> <dt> <em> <font>
<h1> <h2> <h3> <h4>
<h5> <h6> <hr /> <i>
<li> <nbsp> <ol> <p>
<small> <strike> <strong>
<sub> <sup> <table>
<td> <th> <tr> <tt>
<u> <ul>
-
Snippets of code should be wrapped in
<code> tags not
<pre> tags. In fact, <pre>
tags should generally be avoided. If they must
be used, extreme care should be
taken to ensure that their contents do not
have long lines (<70 chars), in order to prevent
horizontal scrolling (and possible janitor
intervention).
-
Want more info? How to link
or How to display code and escape characters
are good places to start.
|
