基于概念传播的软件项目代码注释生成方法
作者:
作者单位:

作者简介:

通讯作者:

邹艳珍,zouyz@pku.edu.cn

中图分类号:

TP311

基金项目:

国家自然科学基金(61972006)


Generating Software Project Code Comment based on Concept Propagation
Author:
Affiliation:

Fund Project:

  • 摘要
  • |
  • 图/表
  • |
  • 访问统计
  • |
  • 参考文献
  • |
  • 相似文献
  • |
  • 引证文献
  • |
  • 资源附件
  • |
  • 文章评论
    摘要:

    软件代码注释生成是软件工程领域近期研究的一个重要问题.目前很多研究工作已经在包含大量<代码片段,注释语句>对的开源数据集上取得了较好效果.但在企业应用中,待注释的代码往往是一个软件项目库,其必须首先决策在哪些代码行上生成注释更好,而且待注释的代码片段大小、粒度各不相同,需要研究提出一种注释决策和生成一体化的、抗噪音的代码注释生成方法.针对这个问题,本文提出了一个面向软件项目的代码自动注释生成方法CoComment.该方法能够自动抽取软件项目文档中的领域基本概念,并基于代码解析与文本匹配进行概念传播和扩展.在此基础上,通过定位概念相关的代码行/段进行自动注释决策,最终利用模板融合概念和上下文生成具有高可读性的自然语言代码注释.目前CoComment已经在3个企业软件项目、超过4.6万条人工代码注释数据上进行了对比试验.结果表明,该方法不仅能够有效地进行代码注释决策,其注释内容与现有方法相比也能够提供更多有益于理解代码的信息,从而为软件项目代码的注释决策和注释生成问题提供了一种一体化的解决方案.

    Abstract:

    Code comment generation has been an important research task in the field of software engineering in the past few years. Some existing work has achieved impressive results on the open source datasets that containing a large number of <code snippet, comment> pairs. However, in the practice of software enterprises, the code to be commented is usually belong to a software project. Different from the code snippets in the open source datasets, the code in a software project has different length and granularity, developers need to know not only how to add comment, but also where to add comments, namely commenting decision. In this paper, we propose CoComment, a software project-oriented code comment generation approach. This approach automatically extracts domain-specific concepts from software documents, then propagates and expands these concepts by code parsing and text matching. On this basis, an automatic code commenting decision method is made by locating code lines or segments related to these concepts, and corresponding natural language comments are generated by fusing concepts and context. We conduct comparative experiments on 3 software projects, containing more than 46,000 manually annotated code comments. The experimental results demonstrate our approach makes code commenting decision accurately and generates more helpful comments compared with existing work, which effectively solve the problem of automatic code comment for software project.

    参考文献
    相似文献
    引证文献
引用本文

潘兴禄,刘陈晓,王敏,邹艳珍,王涛,谢冰.基于概念传播的软件项目代码注释生成方法.软件学报,,():0

复制
分享
文章指标
  • 点击次数:
  • 下载次数:
  • HTML阅读次数:
  • 引用次数:
历史
  • 收稿日期:2021-05-13
  • 最后修改日期:2021-12-19
  • 录用日期:
  • 在线发布日期: 2022-03-24
  • 出版日期:
您是第位访问者
版权所有:中国科学院软件研究所 京ICP备05046678号-3
地址:北京市海淀区中关村南四街4号,邮政编码:100190
电话:010-62562563 传真:010-62562533 Email:jos@iscas.ac.cn
技术支持:北京勤云科技发展有限公司

京公网安备 11040202500063号