Many will notice that I was clever enough not to suggest
how this might be done. Having looked over the
comments, I agree that POD or some other standard would
be great, however these ideas would all rely on the person entering
the code to do work, and so far few do so. Perhaps they
feel that since it is posted under their name they don't
need further identification.
Ideally I'd still like a simple one line comment as I
suggested originally, which would either be the first line
or follow the #! line if it exists. This would ensure
that all downloaded code would have at least minimal
identification (sufficient to track down additional info). If not, then
fundflow's idea is a good alternative. Since
the Monastery already has this information, why rely on
lazy humans? ;-)
Update: In keeping with my theme of giving credit, my apologies
to BastardOperator for not reading to the end of his
node above where he already mentioned automation.
I blame society for my short attention span!
-
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
or How to display code and escape characters
are good places to start.
|
