Automated code review

From HandWiki

Automated code review software checks source code for compliance with a predefined set of rules or best practices. The use of analytical methods to inspect and review source code to detect bugs or security issues has been a standard development practice in both Open Source and commercial software domains.[1] This process can be accomplished both manually and in an automated fashion.[2][3] With automation, software tools provide assistance with the code review and inspection process. The review program or tool typically displays a list of warnings (violations of programming standards). A review program can also provide an automated or a programmer-assisted way to correct the issues found. This is a component for mastering easily software. This is contributing to the Software Intelligence practice. This process is usually called "linting" since one of the first tools for static code analysis was called Lint.

Some static code analysis tools can be used to help with automated code review. They do not compare favorably to manual reviews, however they can be done faster and more efficiently.[citation needed] These tools also encapsulate deep knowledge of underlying rules and semantics required to perform this type analysis such that it does not require the human code reviewer to have the same level of expertise as an expert human auditor.[2] Many Integrated Development Environments also provide basic automated code review functionality. For example the Eclipse[4] and Microsoft Visual Studio[5] IDEs support a variety of plugins that facilitate code review.

Next to static code analysis tools, there are also tools that analyze and visualize software structures and help humans to better understand these. Such systems are geared more to analysis because they typically do not contain a predefined set of rules to check software against. Some of these tools (e.g. Imagix 4D, Resharper, SonarJ, Sotoarc, Structure101, ACTool[6]) allow one to define target architectures and enforce that target architecture constraints are not violated by the actual software implementation.

Automated code review tools

Main page: Software:List of tools for static code analysis

See also

  • Program analysis (computer science)

References

  1. McIntosh, Shane, et al. "The impact of code review coverage and code review participation on software quality: A case study of the qt, vtk, and itk projects." Proceedings of the 11th Working Conference on Mining Software Repositories. 2014. doi:10.1145/2597073.2597076
  2. 2.0 2.1 Gomes, Ivo; Morgado, Pedro; Gomes, Tiago; Moreira, Rodrigo (2009). "An overview of the Static Code Analysis approach in Software Development". Universidade do Porto. http://paginas.fe.up.pt/~ei05021/TQSO%20-%20An%20overview%20on%20the%20Static%20Code%20Analysis%20approach%20in%20Software%20Development.pdf. Retrieved 2010-10-03. 
  3. "Tricorder: Building a Program Analysis Ecosystem". 2015. https://research.google/pubs/pub43322/. 
  4. "Collaborative Code Review Tool Development". www.eclipse.org. Archived from the original on 2010-04-01. https://web.archive.org/web/20100401051935/http://marketplace.eclipse.org/content/collaborative-code-review-tool. Retrieved 2010-10-13. 
  5. "Code Review Plug-in for Visual Studio 2008, ReviewPal". www.codeproject.com. 4 November 2009. http://www.codeproject.com/KB/work/ReviewPal.aspx. Retrieved 2010-10-13. 
  6. Architecture Consistency plugin for Eclipse