This looks like a good start.
I would add a couple of rules about variables:
- Variables should be commented unless clearly self-descriptive,
- Use a consistent variable naming style (I like lower_case_underscore_separated but some odd people prefer allInOneWordWithDanglingCaps,CONSTANT and Package_Variable can also be recommended),
And (of course!) I would argue with a couple of you rules :
14. Any reused code block above 5 lines must become a sub routine
5 lines can be a _LOT_ of code! The risk with that kind of rule is that some people might read it as "it's fine to cut'n paste up to 4 lines of code" or even "don't bother writing a sub that's less than 5 lines"
28. Do not use $_
$_ should not be abused but it has its uses and can make some blocks of code much clearer.
-
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.
|