Code inspections: a web crawler exercise for students

  • Authors:
  • Steena Monteiro;Renee Bryce

  • Affiliations:
  • Utah State University, Logan, UT;Utah State University, Logan, UT

  • Venue:
  • Journal of Computing Sciences in Colleges
  • Year:
  • 2011

Quantified Score

Hi-index 0.05

Visualization

Abstract

It is well known that peer reviews are often effective in finding software bugs. This paper provides a code inspection exercise in which students work in teams to identify problems in code for a web crawler. The code is intentionally poorly written and the code used to work until the website that it visits changed its format! Students must identify poor design and documentation issues in the code. We gave this assignment to student teams in two separate semesters and found that all students identified design and documentation issues. Students were then given an assignment to either modify the existing code or to rewrite a new web crawler from scratch. Even though the modifications would have been relatively small, every team chose to rewrite the code from scratch and cited poor design and documentation issues for this decision. Our in-class discussion of the exercise revealed that the exercise illuminated the importance of good documentation.