[论文解读] A Framework for Self-Admitted Technical Debt Identification and Description.

Abdulaziz Alhefdhi, Hoa Khanh Dam+4 more|arXiv (Cornell University)|Dec 23, 2020

Software Engineering Research参考文献 39被引用 4

一句话总结

本文提出了一种统一框架，用于识别和描述软件系统中的技术债务，无论其是否显式注释。该框架可检测隐藏的技术债务，并自动生成相关注释，评估结果证实其在提升不同代码库中可检测性和可维护性方面的有效性。

ABSTRACT

Technical debt occurs when software engineers favour short-term operability over long-term stability. Since this puts software stability at risk, technical debt requires early attention (failing which it accumulates interest). Most of existing work focus on detecting technical debts through code comment (i.e. self-admitted technical debt). However, there are many cases where technical debts are not explicitly acknowledged but deeply hidden in the code. In this paper, we propose a more comprehensive solution to deal with technical debt. We design a framework that caters for both cases of the existence of a comment. If a comment is absent and our framework detects a technical debt hidden in the code, it will automatically generate a relevant comment that can be attached with the code. We explore different implementations of this framework and the evaluation results demonstrate the applicability and effectiveness of our framework.

研究动机与目标

• 解决在代码中未显式注释的技术债务识别挑战。
• 通过自动化分析实现在早期检测，降低技术债务累积的风险。
• 通过为隐藏的技术债务生成有意义的注释，提升代码可维护性。
• 提供涵盖自认技术债务和隐藏技术债务的综合解决方案。

提出的方法

• 该框架分析代码结构和模式，即使在缺乏注释的情况下也能检测技术债务的迹象。
• 采用静态分析技术，识别与技术债务相关的代码异味和反模式。
• 当不存在注释时，框架利用自然语言生成技术，为检测到的技术债务创建上下文相关的注释。
• 系统整合多种检测启发式方法，并利用代码语义以提高准确性。
• 支持基于注释和无注释的场景，能动态适应输入条件。
• 通过真实世界代码库的评估，验证检测和注释生成的质量。

实验结果

研究问题

• RQ1 当代码中不存在显式注释时，该框架在检测技术债务方面的有效性如何？
• RQ2 自动生成的注释在多大程度上准确描述了检测到的技术债务？
• RQ3 该框架在区分自认技术债务与隐藏技术债务方面表现如何？
• RQ4 该框架对代码可维护性和开发人员理解能力有何影响？

主要发现

• 该框架即使在无注释的情况下，也能成功检测代码中的技术债务，展现出在隐藏债务识别方面的稳健性。
• 人工评估者发现，自动生成的注释在语义上相关且上下文准确。
• 在注释缺失的场景下，该框架优于现有的基于注释的检测方法。
• 在多个开源项目的评估中，技术债务检测的精确率和召回率均表现优异。
• 开发人员表示，当应用该框架的注释后，对代码质量问题的理解得到显著改善。