Code Reviews
Bring to class:
Bring a hard-copy of your source code to class. Be sure it meets
these guidelines:
- Include your name
- Use standard (8.5 x 11) size paper
- Staple pages together
- Print on both sides of the page (optional)
- Max of 5 pages (use 10pt font, extract significant code sample)
- Even if your lab is not completed, provide partial code sample
Written review:
You will be given the source code from another student to review.
Spend 30 minutes reviewing the code. Then write a brief review (max
one page) with your feedback. This assignment should take you one
hour max.
Your review should focus on the strengths and weaknesses of the code.
Keep in mind:
- You are reviewing the code, not the student. Be candid, but polite. Also, prepare yourself to receive constructive criticism on your own source code.
- You may write helpful comments directly on the source code printout (a red pen is recommended).
Topics to consider:
-
Readability
- Well organized, meaningful variable names, suitable comments
- Can your understand clearly what the code is doing?
-
Design
- Efficient algorithm, effective code reuse, error handling
-
Suggestions for improvement
-
Things you learned that will help your own software development skills
Due Date:
Your review is due the next class period at the beginning of class.
|