Instead of a style guide, might I recommend code reviews? Every week or two, have a different member of the team send out copies of the code they're working on or just completed, along with explanation of what it's supposed to be for. Schedule a meeting for that person to walk through the code, explaining it, and have your developers question what they find unclear or dangerous.

Even if you decide to go ahead with a style guide after starting the code reviews, the style guide will be more effective. First of all, since code reviews are a two-way street, you'll be able to see what your coders do and don't understand and what needs explanation (cf. Abigail's why's). Since reviews are a two-way street, your CGI programmers will have had an opportunity to contribute to the process, so they'll be more likely to go along with it. Finally, code reviews give you an opportunity to enforce your style guide.

Personally, though, I find style guides are usually a Procrustean solution. When I've tried writing them in the past, it came from spending so much time programming the computer that I was trying to program the people around me. I understand where most of these rules are coming from, but I've disobeyed most of them in code that I still consider good. Most style guides are enthusiastically propounded, then studiously ignored.


In reply to Re: Perl Programming guidelines/rules by stephen
in thread Perl Programming guidelines/rules by hakkr

Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":

  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.