Handout

F17, ic00

Code Review Exercise Handout

(Note: Due date/time is one hour later for folks in 5pm section, and two hours later for folks in 6pm section.)

Instructions: PART ONE (individual)

Background

In lab02, you implemented:

  public class Polynomial extends ArrayList<Integer>

One of the methods was the toString() method.

Today, you will each be given two implementations of the toString() method by students from previous offerings of CS56.
These students gave their permission for me to share these (anonymously) for this exercise.
So the excerpts are identified by letter only: A, B, C, etc.

You need two different lettered copies, e.g. (A,B), (C,F), (D,K), etc.
It does not matter which ones, as long as they are different—they don’t have to be consecutive. You’ll be in a group with other people with whom you have at least one version in common.

What you need to do:

You job is to review each of these. Your job is not to tear apart the code, but to invite the author into a conversation.

For example:

Review of Solution "G":
+ 105,108,130   Clear use of comments to indicate purpose of code that follows
?  134 		    Would “power” be a better variable name than “x”?
etc.

Further instructions:

SEE REVERSE SIDE FOR GROUP INSTRUCTIONS

 

F17, ic00

Code Review Exercise Handout

Instructions—Part Two (group)

Now get into groups of four, based on ONE of the two codes you reviewed. For example:

You are now invited into a conversation with one another, where you produce a combined review. You will take on four roles:

In fact, none of you is the author of the code—but one of you gets to pretend that she/he is. This will help us practice being “diplomatic” in our sharing. The “pretend author” should advocate for the code “as if” he/she authored it.

Note that ONLY THE RECORDER needs to write down what the group decides; this is a collective submission on behalf of the group, but you are ALL CO-REPSONSIBLE for that submission.

What to do:

foreach (line of code that isn’t initial javadoc) do {
	1) Reader reads the line of code
	2) Moderator asks group what issues they have
	3) All group members read their issues for this line  (moderator last)
	4) Moderator facilitates a discussion
	5) Recorder writes down the issues that reflect the group consensus
		(same syntax as for part 1)
        6) if (this is the last line of code)
	   do all steps 1-5 above again but 
	      from perspective of method “as a whole”
}

Moderator’s roles:

You only need one submission for each group of three-four people, but you are ALL COLLECTIVELY RESPONSIBLE for making sure that the group submission has all of your names, and that it is filled out correctly.

You will be graded on: