TitleWhere should I comment my code? A dataset and model for predicting locations that need comments
Publication TypeConference Paper
Year of Publication2020
AuthorsLouis A, Dash SKumar, Barr ET, Ernst MD, Sutton C
Conference NameICSE NIER, Proceedings of the 42nd International Conference on Software Engineering, New Ideas and Emerging Results Track
Pagination21-24
Date or Month PublishedMay
Conference LocationSeoul, Korea
AbstractProgrammers should write code comments, but not on every line of code. We have created a machine learning model that suggests locations where a programmer should write a code comment. We trained it on existing commented code to learn locations that are chosen by developers. Once trained, the model can predict locations in new code. comment-worthy locations. This first success opens the door to future work, both in the new \emphwhere-to-comment problem and in guiding comment generation. Our code and data is available at \urlhttps://groups.inf.ed.ac.uk/cup/comment-locator/.
Downloadshttps://groups.inf.ed.ac.uk/cup/comment-locator/ implementation and dataset
Citation KeyLouisDBES2020