Title
Code Review and Report to Programmer
Course
CS1
Abstract
Programmers should be able to read code from other programmers in order to determine whether it contains errors. This includes compiler errors, runtime errors, and logic errors. When they identify those errors, they should be able to provide feedback to the programmer who wrote the code in a way that is professional and productive. In this assignment, students read a program, identify and classify the errors it contains, and write a summary to the programmer.
This could be easily modified to include code related to whatever content is being taught.
This could be easily modified to include code related to whatever content is being taught.
Author
Norm Krumpe
Genre
Code report
Assignment Duration
Other
Communication Skill
reading, writing
Technical Skill
Code review, error identification
Workplace Scenario
At work, you will often be asked to read someone else’s code (either entire programs, or portions of programs) in order to identify errors and suggest ways to fix them. The other person may be a colleague working on another project or a member of a project team on which you serve. In these situations, you will be responsible not only for telling the person who programmed the code how to correct the problems but also for helping the programmer avoid those mistakes in the future.
A critical professional ability is the ability to build rather than destroy positive interpersonal relationships when telling others about mistakes they’ve made and how to fix those mistakes. This ability will be especially important when you are working on a team.
A critical professional ability is the ability to build rather than destroy positive interpersonal relationships when telling others about mistakes they’ve made and how to fix those mistakes. This ability will be especially important when you are working on a team.
Team Size
N/A
Collection
Citation
Norm Krumpe, “Code Review and Report to Programmer,” Incorporating Communication Outcomes into the Computer Science Curriculum, accessed May 18, 2020, http://cs-comm.lib.muohio.edu/items/show/37.
Comments