9.6 Million Links in Source Code Comments: Purpose, Evolution, and DecayTechnical Track
Links are an essential feature of the World Wide Web, and source code repositories are no exception. However, despite their many undisputed benefits, links can suffer from decay, insufficient versioning, and lack of bidirectional traceability. In this paper, we investigate the role of links contained in source code comments from these perspectives. We conducted a large-scale study of around 9.6 million links to establish their prevalence, and we used a mixed-methods approach to identify the links’ targets, purposes, decay, and evolutionary aspects. We found that links are prevalent in source code repositories, that licenses, software homepages, and specifications are common types of link targets, and that links are often included to provide metadata or attribution. Links are rarely updated, but many link targets evolve. Almost 10% of the links included in source code comments are dead. We then submitted a batch of link-fixing pull requests to open source software repositories, resulting in several of our fixes being merged successfully. Our findings indicate that links in source code comments can indeed be fragile, and our work opens up avenues for future work to address these problems.
Fri 31 MayDisplayed time zone: Eastern Time (US & Canada) change
16:00 - 17:20 | Software DocumentationTechnical Track / Papers / Software Engineering in Practice / Journal-First Papers at Centre-Ville Chair(s): Bonita Sharif University of Nebraska-Lincoln, USA | ||
16:00 20mTalk | Web Feature Deprecation: A Case Study for ChromeSEIPIndustry Program Software Engineering in Practice Ariana Mirian University of California San Diego, Nikunj Bhagat Google, Caitlin Sadowski , Adriana Porter Felt Google, Stefan Savage University of California San Diego, Geoffrey M. Voelker University of California San Diego | ||
16:20 20mTalk | Software Documentation Issues UnveiledTechnical TrackIndustry Program Technical Track Emad Aghajani Software Institute, USI - Lugano, Switzerland, Csaba Nagy Università della Svizzera italiana (USI), Olga Lucero Vega-Marquez Universidad de los Andes, Universidad de los Llanos, Mario Linares-Vásquez Systems and Computing Engineering Department , Universidad de los Andes , Bogotá, Colombia , Laura Moreno Colorado State University, Gabriele Bavota Università della Svizzera italiana (USI), Michele Lanza Universita della Svizzera italiana (USI) Pre-print | ||
16:40 20mTalk | 9.6 Million Links in Source Code Comments: Purpose, Evolution, and DecayTechnical Track Technical Track Hideaki Hata Nara Institute of Science and Technology, Christoph Treude The University of Adelaide, Raula Gaikovina Kula NAIST, Takashi Ishio Nara Institute of Science and Technology DOI Pre-print Media Attached | ||
17:00 10mTalk | Categorizing the Content of GitHub README FilesJournal-First Journal-First Papers Gede Artha Azriadi Prana Singapore Management University, Christoph Treude The University of Adelaide, Ferdian Thung , Thushari Atapattu The University of Adelaide, David Lo Singapore Management University Link to publication DOI Pre-print | ||
17:10 10mTalk | Discussion Period Papers |