I hate inline POD. It distracts from the code, and occupies
far too much screen space due to the paragraph oriented
syntax, combined with the low level granularity of the markup
(e.g., try making up a bulleted list of arguments for a
given function - you don't see the function anymore, it's
all POD).
Personally, I am much in favor of the solution of Lisp
and Python: the docstring. In this approach, the first
comment after the function definition is taken as documentation
for the function. Because of this, code browsers can extract
the documentation for the function easily.
Christian Lemburg
Brainbench MVP for Perl
http://www.brainbench.com
-
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.
|
