i think this list cramps style too much, to a point of hindering development. while i agree that following a good set of coding standards leads to easier maintenance, i don't think this is the best starting point.
maybe something like:
- style
- follow perlstyle, except as noted below
- do not shift subroutine arguments, use code like my( $self, $arg1, @args ) = @_; instead
- name SCALAR, ARRAY, and HASH variables in the singular, not plural
- use taint mode
- ...
- substance
- untaint all passed parameters
- log all errors/warnings, using #your log module here#
- use CGI to process CGI parameters
- use DBI to access database
- use HTML::Template for HTML templates, not HEREDOCs
- ...
- tests
- write tests for each subroutine
- test modules for pod, using Test::Pod
- test for documentation coverage, using Pod::Coverage
- test modules for version information, using Test::Version
- verify all tests pass before merging code and tests with development stream
- ...
- docs
- document each module with pod, sections include: your sections here
- enter Change Request #(s) in comment upon checkin to SCM repository
- all code must be in SCM repository before release to ...
- ...
but i could be completely off base. it's been a while since i've developed these standards (or followed them in a large team.)
~Particle *accelerates*
-
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.
|
