Design and Code Reviews

Design and Code Reviews

1. Reviews

   • Review Methods
     • Inspection
       • Preparation
       • Inspection meeting
       • Repair and report
     • Walk-through
       • Less formal process.
       • See how the program performs a typical application.
       • Audience raises issues and ask questions.
     • Personal Review
       • You examine your own products
       • Find and fix as many defects as posible before anything else.
   • Review Products
     • Projects should usually put highest priority on reviewing them.
     • Documentation
     • Development plans
     • Test cases
     • Test plans

2. Why Review Programs

   • Review efficiency
   • Code reviews are more effficient than testing

3. Personal Reviews

   • For a quality product, you must spent time engineering it, reviewing it and reworking it.
   • Once you see the defect data, you can work and fix them in the most effective way:
     • Gather and study the data.
     • Decide which defect removal method works best to you.
     • Adjust your process.

4. Review Principles

   • 1. Establish defined review goals.
   • 2. Follow a defined review process.
   • 3. Measure and improve your review process.

5. Separate Design an Code Reviews

   • To make designs more understandable
   • To save implementation time
   • To avoid missing product defects
   • To spot possible design improvements

6. Design Review Principles

   • Produce designs that can be reviewed
   • Follow an explicit review strategy
   • Review the design in stages
   • Verify that the logic correctly implements the requirements.

7. Review Measures

   • The 4 explicit review measures are:
     • Size of program
     • Review time (minutes)
     • # of defects found
     • Escapes
       • # of defects found found later
     • From these you can derive:
       • Review yield
       • Defects/LOC of design or code reviewed
       • Defects/hour of review time
       • LOC reviewed/hour
       • Defect removal leverage (DLR)

8. Checklists

   • Help you to completely follow a procedure.
   • You must follow the checklist exactly.
   • You can divide the checklist into sections that have similar characteristics.

9. Reviewing before or after You Compile

   • PROS-AFTER
     • Some defect types compiling has about twice the leverage of code reviews.
     • The compiler is highly effective.
     • Individual effectiveness varies.
     • Syntax defects missed by the compiler are generally not difficult to find in test.
   • PRO-BEFORE
     • Compiler misses 9% of syntax defects.
     • Will save compile time and make it predictable.
     • Takes more time fixing syntax errors in test than in code review.

10. The Relationship between Reviews and Inspections

    • Inspections are the single most valuable quality technique a software team can use.
    • You should make your code as clean as you can before you have it inspected.
    • It might be helpful to have associates inspect your code before you compile.

Images and files in the map