Reviewing Code
Guidelines for reviewing code.
Criteria
Scope
- To what extent does the code cover the specifications in the problem description?
- Does the code pass unit tests?
Correctness
- To what extent is does the code work as expected?
- To what extent is is the code consistent with the specifications?
- Is the code bug free?
- Note that code may cover the scope but not be correct.
Design
- Is the code efficient?
- Are data structures and algorithms well chosen for efficiency of time and space?
- Could the code be improved? How?
Style
- To what extent is the code well written and readable?
- Is the layout clear?
- Do indentation, spacing, line length, etc. follow coding guidelines?
- Are variables, functions, classes etc. well named?
- Is the code aptly commented? Are the comments consistent with the code?
Importance
The criteria above are given in order of importance. Grades are calculated according to the formula
grade = scope * (3 * correctness + 2 * design + style)
Scale
- 3
- Essentially complete. Negligible room for improvement.
- 2
- Functional but incomplete. Some room for improvement.
- 1
- Insufficient. Lacking.
- 0
- No attempt made at all.