How do Developers Document Database Usages in Source Code? (N)

2015 30th IEEE/ACM International Conference on Automated Software Engineering (ASE) Pub Date : 2015-11-09 DOI:10.1109/ASE.2015.67

M. Vásquez, Boyang Li, Christopher Vendome, D. Poshyvanyk

{"title":"How do Developers Document Database Usages in Source Code? (N)","authors":"M. Vásquez, Boyang Li, Christopher Vendome, D. Poshyvanyk","doi":"10.1109/ASE.2015.67","DOIUrl":null,"url":null,"abstract":"Database-centric applications (DCAs) usually contain a large number of tables, attributes, and constraints describing the underlying data model. Understanding how database tables and attributes are used in the source code along with the constraints related to these usages is an important component of DCA maintenance. However, documenting database-related operations and their constraints in the source code is neither easy nor common in practice. In this paper, we present a two-fold empirical study aimed at identifying how developers document database usages at source code method level. In particular, (i) we surveyed open source developers to understand their practices on documenting database usages in source code, and (ii) we mined a large set of open source projects to measure to what extent database-related methods are commented and if these comments are updated during evolution. Although 58% of the developers claimed to find value in method comments describing database usages, our findings suggest that 77% of 33K+ methods in 3.1K+ open-source Java projects with database accesses were completely undocumented.","PeriodicalId":6586,"journal":{"name":"2015 30th IEEE/ACM International Conference on Automated Software Engineering (ASE)","volume":"39 1","pages":"36-41"},"PeriodicalIF":0.0000,"publicationDate":"2015-11-09","publicationTypes":"Journal Article","fieldsOfStudy":null,"isOpenAccess":false,"openAccessPdf":"","citationCount":"18","resultStr":null,"platform":"Semanticscholar","paperid":null,"PeriodicalName":"2015 30th IEEE/ACM International Conference on Automated Software Engineering (ASE)","FirstCategoryId":"1085","ListUrlMain":"https://doi.org/10.1109/ASE.2015.67","RegionNum":0,"RegionCategory":null,"ArticlePicture":[],"TitleCN":null,"AbstractTextCN":null,"PMCID":null,"EPubDate":"","PubModel":"","JCR":"","JCRName":"","Score":null,"Total":0}

引用次数: 18

Abstract

Database-centric applications (DCAs) usually contain a large number of tables, attributes, and constraints describing the underlying data model. Understanding how database tables and attributes are used in the source code along with the constraints related to these usages is an important component of DCA maintenance. However, documenting database-related operations and their constraints in the source code is neither easy nor common in practice. In this paper, we present a two-fold empirical study aimed at identifying how developers document database usages at source code method level. In particular, (i) we surveyed open source developers to understand their practices on documenting database usages in source code, and (ii) we mined a large set of open source projects to measure to what extent database-related methods are commented and if these comments are updated during evolution. Although 58% of the developers claimed to find value in method comments describing database usages, our findings suggest that 77% of 33K+ methods in 3.1K+ open-source Java projects with database accesses were completely undocumented.

查看原文

微信好友朋友圈 QQ好友复制链接

本刊更多论文

开发人员如何在源代码中记录数据库的使用?(N)

以数据库为中心的应用程序(dca)通常包含大量描述底层数据模型的表、属性和约束。了解如何在源代码中使用数据库表和属性以及与这些用法相关的约束是DCA维护的一个重要组成部分。然而，在源代码中记录与数据库相关的操作及其约束在实践中既不容易也不常见。在本文中，我们提出了一个双重的实证研究，旨在确定开发人员如何在源代码方法级别记录数据库的使用。特别是，(i)我们调查了开源开发人员，了解他们在源代码中记录数据库用法的做法，(ii)我们挖掘了大量的开源项目，以衡量与数据库相关的方法被注释到什么程度，以及这些注释在发展过程中是否被更新。尽管58%的开发人员声称在描述数据库用法的方法注释中发现了价值，但我们的研究结果表明，在3.1K以上具有数据库访问的开源Java项目中，有77%的33K以上方法完全没有文档记录。

本文章由计算机程序翻译，如有差异，请以英文原文为准。

求助全文

约1分钟内获得全文去求助

来源期刊

2015 30th IEEE/ACM International Conference on Automated Software Engineering (ASE)

自引率

0.00%

发文量

期刊最新文献

Cost-Efficient Sampling for Performance Prediction of Configurable Systems (T) Refactorings for Android Asynchronous Programming Study and Refactoring of Android Asynchronous Programming (T) The iMPAcT Tool: Testing UI Patterns on Mobile Applications Combining Deep Learning with Information Retrieval to Localize Buggy Files for Bug Reports (N)