Towards a Taxonomy of Inline Code Comment Smells

被引:2
作者
Jabrayilzade, Elgun [1 ]
Gurkan, Olcaytu [1 ]
Tuzun, Eray [1 ]
机构
[1] Bilkent Univ, Dept Comp Engn, Ankara, Turkey
来源
IEEE 21ST INTERNATIONAL WORKING CONFERENCE ON SOURCE CODE ANALYSIS AND MANIPULATION (SCAM 2021) | 2021年
关键词
code comment; code smell; dataset; taxonomy; multivocal literature review;
D O I
10.1109/SCAM52516.2021.00024
中图分类号
TP31 [计算机软件];
学科分类号
081202 ; 0835 ;
摘要
Code comments play a vital role in source code comprehension and software maintainability. It is common for developers to write comments for explaining a code snippet. However, low-quality comments can have a detrimental effect on software quality or be ineffective for code understanding. This study aims to create a taxonomy of inline code comment smells and determine how commonly each smell type occurs in software projects. We conducted a multivocal literature review for defining the initial taxonomy of inline comment smells. Afterward, we manually labeled 899 inline comments from three open-source Java projects. We created a taxonomy of 11 inline code comment smell types and found out that the smells exist in practice with varying degrees.
引用
收藏
页码:131 / 135
页数:5
相关论文
共 15 条
  • [1] Guidelines for including grey literature and conducting multivocal literature reviews in software engineering
    Garousi, Vahid
    Felderer, Michael
    Mantyla, Mika V.
    [J]. INFORMATION AND SOFTWARE TECHNOLOGY, 2019, 106 : 101 - 121
  • [2] Applying systematic review search methods to the grey literature: a case study examining guidelines for school-based breakfast programs in Canada
    Godin, Katelyn
    Stapleton, Jackie
    Kirkpatrick, Sharon I.
    Hanning, Rhona M.
    Leatherdale, Scott T.
    [J]. SYSTEMATIC REVIEWS, 2015, 4
  • [3] How Good is your Comment? A study of Comments in Java']Java Programs
    Haouari, Dorsaf
    Sahraoui, Houari
    Langlais, Philippe
    [J]. 2011 FIFTH INTERNATIONAL SYMPOSIUM ON EMPIRICAL SOFTWARE ENGINEERING AND MEASUREMENT (ESEM 2011), 2011, : 137 - 146
  • [4] Hartzman C. S., 1993, Proceedings CASCON '93, P138
  • [5] Jingyi Zhang, 2018, Web Information Systems and Applications. 15th International Conference, WISA 2018. Proceedings: Lecture Notes in Computer Science (LNCS 11242), P39, DOI 10.1007/978-3-030-02934-0_4
  • [6] Automatic Detection of Five API Documentation Smells: Practitioners' Perspectives
    Khan, Junaed Younus
    Khondaker, Md Tawkat Islam
    Uddin, Gias
    Iqbal, Anindya
    [J]. 2021 IEEE INTERNATIONAL CONFERENCE ON SOFTWARE ANALYSIS, EVOLUTION AND REENGINEERING (SANER 2021), 2021, : 318 - 329
  • [7] Is there a Correlation Between Code Comments and Issues? - An Exploratory Study
    Misra, Vishal
    Reddy, Jakku Sai Krupa
    Chimalakonda, Sridhar
    [J]. PROCEEDINGS OF THE 35TH ANNUAL ACM SYMPOSIUM ON APPLIED COMPUTING (SAC'20), 2020, : 110 - 117
  • [8] The depth and breadth of Google Scholar: An empirical study
    Neuhaus, Chris
    Neuhaus, Ellen
    Asher, Alan
    Wrede, Clint
    [J]. PORTAL-LIBRARIES AND THE ACADEMY, 2006, 6 (02) : 127 - 141
  • [9] Listening to Programmers - Taxonomies and Characteristics of Comments in Operating System Code
    Padioleau, Yoann
    Tan, Lin
    Zhou, Yuanyuan
    [J]. 2009 31ST INTERNATIONAL CONFERENCE ON SOFTWARE ENGINEERING, PROCEEDINGS, 2009, : 331 - 341
  • [10] Classifying code comments in Java']Java open-source software systems
    Pascarella, Luca
    Bacchelli, Alberto
    [J]. 2017 IEEE/ACM 14TH INTERNATIONAL CONFERENCE ON MINING SOFTWARE REPOSITORIES (MSR 2017), 2017, : 227 - 237