Beefy Boxes and Bandwidth Generously Provided by pair Networks
There's more than one way to do things

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??

I've been in charge of code reviews at work for about six months now. A few random points:

  • Before the code review, the code should be pushed through Perl::Tidy and Perl::Critic according to your internal coding standards. This avoids wasting time arguing about code layout and basic style issues. If you find things in a code review that were not detected by Perl::Critic, see if you can tweak your Perl::Critic policies to find them next time.
  • The code review must be in writing. Otherwise, there is no proof it has been performed.
  • Most of the code review work should be done before the code review meeting.
  • Have at least two code reviewers.
  • Take a look a Fagan Inspections. Though probably more formal than you want, you should get some good code review ideas from this well-respected method.

According to Karl Wiegers, the Seven Deadly Sins of Software Reviews are:

  • Participants don't understand the review process.
  • Reviewers critique the producer, not the product.
  • Reviews are not planned.
  • Review meetings drift into problem-solving.
  • Reviewers are not prepared.
  • The wrong people participate.
  • Reviewers focus on style, not substance.

Some useful code review links:

Update: See also Re: I need perl coding standards (Coding Standards Links)

In reply to Re: How should I do (and document) effective semi-formal code review? by eyepopslikeamosquito
in thread How should I do (and document) effective semi-formal code review? by radiantmatrix

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?

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

How do I use this? | Other CB clients
Other Users?
Others drinking their drinks and smoking their pipes about the Monastery: (4)
As of 2023-09-23 10:53 GMT
Find Nodes?
    Voting Booth?

    No recent polls found