...
首页> 外文期刊>International journal of software engineering and knowledge engineering >Code Comment Quality Analysis and Improvement Recommendation: An Automated Approach
【24h】

Code Comment Quality Analysis and Improvement Recommendation: An Automated Approach

机译:代码注释质量分析和改进建议:一种自动化方法

获取原文
获取原文并翻译 | 示例
           

摘要

Program comprehension is one of the first and most frequently performed activities during software maintenance and evolution. In a program, there are not only source code, but also comments. Comments in a program is one of the main sources of information for program comprehension. If a program has good comments, it will be easier for developers to understand it. Unfortunately, for many software systems, due to developers' poor coding style or hectic work schedule, it is often the case that a number of methods and classes are not written with good comments. This can make it difficult for developers to understand the methods and classes, when they are performing future software maintenance tasks. To deal with this problem, in this paper we propose an approach which assesses the quality of a code comment and generates suggestions to improve comment quality. A user study is conducted to assess the effectiveness of our approach and the results show that our comment quality assessments are similar to the assessments made by our user study participants, the suggestions provided by our approach are useful to improve comment quality, and our approach can improve the accuracy of the previous comment quality analysis approaches.
机译:程序理解是软件维护和演化过程中最先执行的也是最频繁执行的活动之一。在程序中,不仅有源代码,而且还有注释。程序中的注释是程序理解的主要信息来源之一。如果程序有良好的注释,开发人员将更容易理解它。不幸的是,对于许多软件系统而言,由于开发人员的编码风格较差或工作日程繁忙,通常情况下,许多方法和类的注释都不好。当开发人员执行未来的软件维护任务时,这可能会使开发人员难以理解方法和类。为了解决这个问题,本文提出了一种评估代码注释质量并生成建议以提高注释质量的方法。进行了一项用户研究,以评估我们方法的有效性,结果表明,我们的评论质量评估与我们的用户研究参与者所做的评估相似,我们的方法提供的建议有助于提高评论质量,并且我们的方法可以提高先前评论质量分析方法的准确性。

著录项

相似文献

  • 外文文献
  • 中文文献
  • 专利
获取原文

客服邮箱:kefu@zhangqiaokeyan.com

京公网安备:11010802029741号 ICP备案号:京ICP备15016152号-6 六维联合信息科技 (北京) 有限公司©版权所有
  • 客服微信

  • 服务号