Supporting software documentation with source code summarization

被引:4
|
作者
Al-Msie'deen, Ra'Fat [1 ]
Blasi, Anas H. [1 ]
机构
[1] Mutah Univ, Fac IT, Dept Comp Informat Syst, POB 7, Mutah 61710, Karak, Jordan
关键词
Software engineering; Software documentation; Source code summarization; Software comprehension; Summary;
D O I
10.21833/ijaas.2019.01.008
中图分类号
O [数理科学和化学]; P [天文学、地球科学]; Q [生物科学]; N [自然科学总论];
学科分类号
07 ; 0710 ; 09 ;
摘要
Source code summarization is a process of generating summaries that describe software code, the majority of source code summarization usually generated manually, where the summaries are written by software developers. Recently, new automated approaches are becoming more useful. These approaches have been found to be effective in some cases. The main weaknesses of these approaches are that they never exploit code dependencies and summarize either the software classes or methods but not both. This paper proposes a source code summarization approach (Suncode) that produces a short description for each class and method in the software system. To validate the approach, it has been applied to several case studies. Moreover, the generated summaries are compared to summaries that written by human experts and to summaries that written by a state-of-theart solution. Results of this paper found that Suncode summaries provide better information about code dependencies comparing with other studies. In addition, Suncode summaries can improve and support the current software documentation. The results found that manually written summaries were more precise and short as well. (C) 2018 The Authors. Published by IASE.
引用
收藏
页码:59 / 67
页数:9
相关论文
共 50 条
  • [1] Automatic Documentation Generation via Source Code Summarization
    McBurney, Paul W.
    [J]. 2015 IEEE/ACM 37TH IEEE INTERNATIONAL CONFERENCE ON SOFTWARE ENGINEERING, VOL 2, 2015, : 903 - 906
  • [2] Software Documentation through Source Code Annotations
    Nosal, Milan
    Porubaen, Jaroslav
    [J]. INFORMATICS 2013: PROCEEDINGS OF THE TWELFTH INTERNATIONAL CONFERENCE ON INFORMATICS, 2013, : 180 - 185
  • [3] Recovery of traceability links between software documentation and source code
    Marcus, A
    Maletic, JI
    Sergeyev, A
    [J]. INTERNATIONAL JOURNAL OF SOFTWARE ENGINEERING AND KNOWLEDGE ENGINEERING, 2005, 15 (05) : 811 - 836
  • [4] Autofolding for Source Code Summarization
    Fowkes, Jaroslav
    Chanthirasegaran, Pankajan
    Ranca, Razvan
    Allamanis, Miltiadis
    Lapata, Mirella
    Sutton, Charles
    [J]. IEEE TRANSACTIONS ON SOFTWARE ENGINEERING, 2017, 43 (12) : 1095 - 1109
  • [5] A Review on Source Code Documentation
    Rai, Sawan
    Belwal, Ramesh Chandra
    Gupta, Atul
    [J]. ACM TRANSACTIONS ON INTELLIGENT SYSTEMS AND TECHNOLOGY, 2022, 13 (05)
  • [6] Distilled GPT for source code summarization
    Chia-Yi Su
    Collin McMillan
    [J]. Automated Software Engineering, 2024, 31
  • [7] A review of automatic source code summarization
    Zhang, Xuejun
    Hou, Xia
    Qiao, Xiuming
    Song, Wenfeng
    [J]. Empirical Software Engineering, 2024, 29 (06)
  • [8] TASSAL: Autofolding for Source Code Summarization
    Fowkes, Jaroslav
    Chanthirasegaran, Pankajan
    Ranca, Razvan
    Allamanis, Miltiadis
    Lapata, Mirella
    Sutton, Charles
    [J]. 2016 IEEE/ACM 38TH INTERNATIONAL CONFERENCE ON SOFTWARE ENGINEERING COMPANION (ICSE-C), 2016, : 649 - 652
  • [9] POSITION PAPER: Documentation Generation from Annotated Source Code of Scientific Software
    Moser, Michael
    Pichler, Josef
    [J]. PROCEEDINGS OF 2016 IEEE/ACM INTERNATIONAL WORKSHOP ON SOFTWARE ENGINEERING FOR SCIENCE (SE4SCIENCE), 2016, : 12 - 15
  • [10] Recovering Relationships between Documentation and Source Code based on the Characteristics of Software Engineering
    Wang, Xiaobo
    Lai, Guanhui
    Liu, Chao
    [J]. ELECTRONIC NOTES IN THEORETICAL COMPUTER SCIENCE, 2009, 243 : 121 - 137