ABSTRACT

Code review is a useful technique for reducing the number of mistakes as it is a check on the work before using the code for real. Code review generally involves having one person who writes the code send it to another person who checks the code for any potential mistakes or issues. For the person having their code reviewed, having comments explaining the what and why of the code will help the reviewer quickly go through the code. For code review to be most efficient, authors recommend developing some rules with your collaborators to specify how and when code review is done. They will talk about documentation in two ways, through comments, which focus on specific parts of code, and vignettes, which document the project more broadly. Stopping to write a comment on something that seems obvious at the time interrupts the flow of writing code and slows down your work.