Beefy Boxes and Bandwidth Generously Provided by pair Networks
Problems? Is your data what you think it is?
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??

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.

stephen


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

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



  • 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.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others surveying the Monastery: (8)
As of 2024-03-28 11:47 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found