Recommending Code Understandability Improvements Based on Code Reviews
Author:
- 1 November 2021
- conference paper
- Published by Institute of Electrical and Electronics Engineers (IEEE)
- p. 131-132
Abstract
Developers spend 70% of their time understanding code. Code that is easy to read can save time, while hard-to-read code can lead to the introduction of bugs. However, it is difficult to establish what makes code more understandable. Although there are guides and directives on improving code understandability, in some contexts, these practices can have a detrimental effect. Practical software development projects often employ code review to improve code quality, including understandability. Reviewers are often senior developers who have contributed extensively to projects and have an in-depth understanding of the impacts of different solutions on code understandability. This paper is an early research proposal to recommend code understandability improvements based on code reviewer knowledge. The core of the proposal comprises a dataset of code understandability improvements extracted from code reviews. This dataset will serve as a basis to train machine learning systems to recommend understandability improvements.Keywords
All Related Versions
Funding Information
- CAPES/Brazil (88887.582851/2020-0)
This publication has 13 references indexed in Scilit:
- Evaluating Code Readability and Legibility: An Examination of Human-centric Studies2020
- A Model to Detect Readability Improvements in Incremental Changes2020
- Indentation: Simply a Matter of Style or Support for Program Comprehension?2019
- Are Static Analysis Violations Really Fixed? A Closer Look at Realistic Usage of SonarQube2019
- An investigation of misunderstanding code patterns in C open-source software projectsEmpirical Software Engineering, 2018
- Modern code review2018
- Confusion Detection in Code Reviews2017
- Understanding misunderstandings in source code2017
- Code convention adherence in evolving software2011
- Program indentation and comprehensibilityCommunications of the ACM, 1983