{"id":51,"date":"2010-03-11T21:22:38","date_gmt":"2010-03-12T02:22:38","guid":{"rendered":"http:\/\/littlesvr.ca\/masters\/?p=51"},"modified":"2010-05-30T18:59:22","modified_gmt":"2010-05-30T22:59:22","slug":"code-review-using-tablets-literature-review-1","status":"publish","type":"post","link":"http:\/\/littlesvr.ca\/masters\/2010\/03\/11\/code-review-using-tablets-literature-review-1\/","title":{"rendered":"Code review using tablets – literature review (1)"},"content":{"rendered":"

I looked for existing work and opinion on code review using tablets today.<\/p>\n

I started by looking for people who do what I do at work – print out the code to be reviewed. It looks like I’m not very unusual in thinking this is a worthwhile thing to do, in fact the practice seems almost common. But I haven’t felt great love for printouts out there.<\/p>\n

Gonsalves and Murthy<\/a> (2001) say a couple of interesting things:<\/p>\n

The reviewer should not try to fix any bugs or improve the code. S\/he should merely inform the programmer about potential bugs and possible improvements.<\/p><\/blockquote>\n

2. Steps in Code Review
\n1. Obtain print-outs of the specs and design documents, and of the code.<\/p><\/blockquote>\n

That second suggestion is interesting. If for no other reason than that it shows reviewing code using a text editor is considered inefficient by some.<\/p>\n

Some in the wild call printouts “a conventional techniqe<\/a>” or “soooo 1976”. That doesn’t surprise me, in fact I’m surprised this is not a dominant opinion. Programmers love gadgets and fancy software.<\/p>\n

Looking at tablet code review in particular I was glad to see there isn’t much. At first I thought this is a completely unexplored idea, but then I found “A System for Developing Tablet PC Applications for Education” (2008), guys who developed such an application. The software was not made especially for code review (it’s only one use case) and I’m not sure it was ever completed (“This application is under active development. We do not know what set of features will best facilitate discussion of
\neach student\u2019s code.”). There’s a note Mike might find interesting:<\/p>\n

Our department has a required class for juniors, entitled \u201cProgramming Studio,\u201d in which students meet each week, in small groups, to review each other\u2019s code [13].<\/p><\/blockquote>\n

“Panel: Using Peer Review in Teaching Computing” mentions “Using a Tablet-PC to Provide Peer-Review Comments”, a simple experiment which found (among other things) that:<\/p>\n

In general, we found that the most natural medium for providing comments was the paper\/pen. However, that medium also invited more editing-style com- ments, which were not necessarily appropriate for the task at hand.<\/p><\/blockquote>\n

Good, that’s good. “Inking in the IDE: Experiences with Pen-based Design and Annotation” is mostly about drawing diagrams, but they do mention code annotations and that unfortunately they don’t work because they’re not integrated with IDEs.<\/p>\n

“Moving Markup: Repositioning Freeform Annotations” (2006) is not about code review, they developed a system to allow for annotating text on a tablet, and mention something I like:<\/p>\n

Freeform digital ink annotation allows readers to interact with documents in an intuitive and familiar manner. Such marks are easy to manage on static documents, and provide a familiar annotation experience.<\/p><\/blockquote>\n

And here’s what I was afraid of, this concept has been not only considered but implemented multiple times. “CodeAnnotator: Digital Ink Annotation within Eclipse” (2007) mention Penmarked and RCA as “limited” solutions. Also they go over their own implementation:<\/p>\n

\"Eclipse<\/a><\/p>\n

Bah, I really hoped I would be the first to implement something like this. Oh well.<\/p>\n

“A Pen-based Paperless Environment for Annotating and Marking Student Assignments<\/a>” (2006) describes Penmarked. Again – it looks like just an implementation, with no serious evaluation of its efficiency.<\/p>\n

“RCA: Experiences with an IDE Annotation Tool” is about (surprise) RCA. Thankfully this is also only an implementation. These guys integrated it with Visual Studio. Doesn’t look like it’s gone beyond a research project.<\/p>\n

I can’t take it any more, I will have to continue later. Maybe saturday. Just looking at the long list of references in the papers above makes me sick.<\/p>\n","protected":false},"excerpt":{"rendered":"

I looked for existing work and opinion on code review using tablets today. I started by looking for people who do what I do at work – print out the code to be reviewed. It looks like I’m not very unusual in thinking this is a worthwhile thing to do, in fact the practice seems […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"_links":{"self":[{"href":"http:\/\/littlesvr.ca\/masters\/wp-json\/wp\/v2\/posts\/51"}],"collection":[{"href":"http:\/\/littlesvr.ca\/masters\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/littlesvr.ca\/masters\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/littlesvr.ca\/masters\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"http:\/\/littlesvr.ca\/masters\/wp-json\/wp\/v2\/comments?post=51"}],"version-history":[{"count":7,"href":"http:\/\/littlesvr.ca\/masters\/wp-json\/wp\/v2\/posts\/51\/revisions"}],"predecessor-version":[{"id":57,"href":"http:\/\/littlesvr.ca\/masters\/wp-json\/wp\/v2\/posts\/51\/revisions\/57"}],"wp:attachment":[{"href":"http:\/\/littlesvr.ca\/masters\/wp-json\/wp\/v2\/media?parent=51"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/littlesvr.ca\/masters\/wp-json\/wp\/v2\/categories?post=51"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/littlesvr.ca\/masters\/wp-json\/wp\/v2\/tags?post=51"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}