So far I haven't seen a comment that echos my thoughts. But I like both inline and EOF POD for two different purposes.
Inline works great when you are writing a module, you put some POD at the beginning and the end of the file, but it's nice to have the documentation for the methods right next to the code. This still produces a very usable perldoc page.
But for the end-user application (and I assume that this is either a shorter script or the glue script for a set of modules) I'd just put the whole POD either at the start or the end of the file since it is probably not necessary (or even desirable) to use POD to comment code.
-
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.
|