Top Qs
Timeline
Chat
Perspective
Code review
Activity where one or more people check a program's code From Wikipedia, the free encyclopedia
Remove ads
Code review (sometimes referred to as peer review) is a software quality assurance activity in which one or more people examine the source code of a computer program, either after implementation or during the development process. The persons performing the checking, excluding the author, are called "reviewers". At least one reviewer must not be the code's author.[1][2]
Code review differs from related software quality assurance techniques like static code analysis, self-checks, testing, and pair programming. Static analysis relies primarily on automated tools, self-checks involve only the author, testing requires code execution, and pair programming is performed continuously during development rather than as a separate step.[1]
Remove ads
Goal
Although direct discovery of quality problems is often the main goal,[3] code reviews are usually performed to reach a combination of goals:[4][5]
- Improving code quality – Improve internal code quality and maintainability through better readability, uniformity, and understandability
- Detecting defects – Improve quality regarding external aspects, especially correctness, but also find issues such as performance problems, security vulnerabilities, and injected malware
- Learning/Knowledge transfer – Sharing codebase knowledge, solution approaches, and quality expectations, both to the reviewers and the author
- Increase sense of mutual responsibility – Increase a sense of collective code ownership and solidarity
- Finding better solutions – Generate ideas for new and better solutions and ideas beyond the specific code at hand
- Complying to QA guidelines, ISO/IEC standards – Code reviews are mandatory in some contexts, such as air traffic software and safety-critical software
Remove ads
Review types
Summarize
Perspective
Several variations of code review processes exist, with additional types specified in IEEE 1028.[6]
- Management reviews
- Technical reviews
- Inspections
- Walk-throughs
- Audits
Inspection (formal)
Historically, the first code review process that was studied and described in detail was called "Inspection" by its inventor, Michael Fagan.[7] Fagan inspection is a formal process that involves a careful and detailed execution with multiple participants and phases. In formal code reviews, software developers attend a series of meetings to examine code line by line, often using printed copies. Research has shown formal inspections to be extremely thorough and highly effective at identifying defects.[7]
Regular change-based code review (Walk-throughs)
Software development teams typically adopt a more lightweight review process in which the scope of each review is on the changes to the codebase performed in a ticket, user story, commit, or some other unit of work.[8][3] Furthermore, there are rules or conventions that integrate the review task into the development workflow through conventions like mandatory review of all tickets, commonly as part of a pull request, instead of explicitly planning each review. Such a process is called "regular, change-based code review".[1] There are many variations of this basic process.
A 2017 survey of 240 development teams found that 90% of teams using code review followed a change-based process, with 60% specifically using regular change-based review.[3] Major software corporations known to use changed-based code review include Microsoft,[9] Google,[10] and Facebook.
Remove ads
Efficiency and effectiveness
Summarize
Perspective
Ongoing research by Capers Jones analyzing over 12,000 software development projects found formal inspections had a latent defect discovery rate of 60-65%, while informal inspections detected fewer than 50% of defects. The latent defect discovery rate for most forms of testing is about 30%.[11][12] A code review case study published in the book Best Kept Secrets of Peer Code Review contradicted the Capers Jones study,[11] finding that lightweight reviews can uncover as many bugs as formal reviews while being more efficient in terms of cost and money[13]
Studies indicate that up to 75% of code review comments affect software evolvability and maintainability rather than functionality,[14][15][4][16] suggesting that code reviews are an excellent tool for software companies with long product or system life cycles.[17] Therefore, less than 15% of issues discussed in code reviews relate directly to bugs.[18]
Guidelines
Research indicates review effectiveness correlates with review speed. Optimal code review rates range from 200 to 400 lines of code per hour.[19][20][21][22] Inspecting and reviewing more than a few hundred lines of code per hour for critical software (such as safety critical embedded software) may be too fast to find errors.[19][23]
Supporting tools
Static code analysis software assist reviewers by automatically checking source code for known vulnerabilities and defect patterns, particularly for large chunks of code.[24] A 2012 study by VDC Research reports that 17.6% of the embedded software engineers surveyed currently use automated tools to support peer code review and 23.7% plan to use them within two years.[25]
See also
External links
References
Wikiwand - on
Seamless Wikipedia browsing. On steroids.
Remove ads