English
Related papers

Related papers: What Makes a Good TODO Comment?

200 papers

Background: Software security is crucial to ensure that the users are protected from undesirable consequences such as malware attacks which can result in loss of data and, subsequently, financial loss. Technical Debt (TD) is a metaphor…

Software Engineering · Computer Science 2023-07-24 Joshua Aldrich Edbert , Sahrima Jannat Oishwee , Shubhashis Karmakar , Zadia Codabux , Roberto Verdecchia

Amidst the ever-expanding digital sphere, the evolution of the Internet has not only fostered an atmosphere of information transparency and sharing but has also sparked a revolution in software development practices. The distributed nature…

Software Engineering · Computer Science 2024-12-23 Qing Wang , Junjie Wang , Mingyang Li , Yawen Wang , Zhe Liu

We introduce the Constructive Comments Corpus (C3), comprised of 12,000 annotated news comments, intended to help build new tools for online communities to improve the quality of their discussions. We define constructive comments as…

Computation and Language · Computer Science 2020-08-06 Varada Kolhatkar , Nithum Thain , Jeffrey Sorensen , Lucas Dixon , Maite Taboada

The code review comment (CRC) is pivotal in the process of modern code review. It provides reviewers with the opportunity to identify potential bugs, offer constructive feedback, and suggest improvements. Clear and concise code review…

Software Engineering · Computer Science 2025-04-25 Junkai Chen , Zhenhao Li , Qiheng Mao , Xing Hu , Kui Liu , Xin Xia

Popular and large contemporary open-source projects now embrace a diverse set of documentation for communication channels. Examples include contribution guidelines (i.e., commit message guidelines, coding rules, submission guidelines), code…

Software Engineering · Computer Science 2023-07-17 Dong Wang , Masanari Kondo , Yasutaka Kamei , Raula Gaikovina Kula , Naoyasu Ubayashi

Toxic conversations during software development interactions may have serious repercussions on a Free and Open Source Software (FOSS) development project. For example, victims of toxic conversations may become afraid to express themselves,…

Software Engineering · Computer Science 2023-02-09 Jaydeb Sarker , Asif Kamal Turzo , Ming Dong , Amiangshu Bosu

Large language models (LLMs) have demonstrated impressive performance in code generation, particularly when augmented with chain-of-thought (CoT) prompting techniques. They break down requirements into intermediate reasoning steps, which…

Software Engineering · Computer Science 2025-07-10 Binquan Zhang , Li Zhang , Zhiwen Luo , Yuxin Du , Fang Liu , Song Wang , Lin Shi

Crowdsourcing enables one to leverage on the intelligence and wisdom of potentially large groups of individuals toward solving problems. Common problems approached with crowdsourcing are labeling images, translating or transcribing text,…

Human-Computer Interaction · Computer Science 2018-01-09 Florian Daniel , Pavel Kucherbaev , Cinzia Cappiello , Boualem Benatallah , Mohammad Allahbakhsh

Good software documentation encourages good software engineering, but the meaning of "good" documentation is vaguely defined in the software engineering literature. To clarify this ambiguity, we draw on work from the data and information…

Software Engineering · Computer Science 2020-09-09 Christoph Treude , Justin Middleton , Thushari Atapattu

Software maintenance constitutes a substantial portion of the total lifetime costs of software, with a significant portion attributed to code comprehension. Software comprehension is eased by documentation such as comments that summarize…

Software Engineering · Computer Science 2024-07-19 Skyler Grandel , Scott Thomas Andersen , Yu Huang , Kevin Leach

Software engineering has long studied how software developers work, building a body of work which forms the foundation of many software engineering best practices, tools, and theories. Recently, some developers have begun recording videos…

Software Engineering · Computer Science 2019-05-28 Abdulaziz Alaboudi , Thomas D. LaToza

Code comments are essential for clarifying code functionality, improving readability, and facilitating collaboration among developers. Despite their importance, comments often become outdated, leading to inconsistencies with the…

Software Engineering · Computer Science 2024-09-18 Shiva Radmanesh , Aaron Imani , Iftekhar Ahmed , Mohammad Moshirpour

Code comments provide important information for understanding the source code. They can help developers understand the overall purpose of a function or class, as well as identify bugs and technical debt. However, an overabundance of…

Computation and Language · Computer Science 2024-08-12 Nam Le Hai , Nghi D. Q. Bui

GitHub introduced the suggestion feature to enable reviewers to explicitly suggest code modifications in pull requests. These suggestions make the reviewers' feedback more actionable for the submitters and represent a valuable knowledge for…

Software Engineering · Computer Science 2025-02-10 Abir Bouraffa , Yen Dieu Pham , Walid Maalej

Technical Debt is a common issue that arises when short-term gains are prioritized over long-term costs, leading to a degradation in the quality of the code. Self-Admitted Technical Debt (SATD) is a specific type of Technical Debt that…

Software Engineering · Computer Science 2024-04-03 Shima Esfandiari , Ashkan Sami

Massive Open Online Courses (MOOCs) have been used by students as a low-cost and low-touch educational credential in a variety of fields. Understanding the grading mechanisms behind these course assignments is important for evaluating MOOC…

Computers and Society · Computer Science 2021-04-27 Siruo Wang , Leah R. Jager , Kai Kammers , Aboozar Hadavand , Jeffrey T. Leek

Modern programming languages like Java require runtime systems to support the implementation and deployment of software applications in diverse computing platforms and operating systems. These runtime systems are normally developed in…

Software Engineering · Computer Science 2023-10-25 Salma Begum Tamanna , Gias Uddin , Lan Xia , Longyu Zhang

Automated source code summarization is a popular software engineering research topic wherein machine translation models are employed to "translate" code snippets into relevant natural language descriptions. Most evaluations of such models…

Software Engineering · Computer Science 2021-06-17 Junayed Mahmud , Fahim Faisal , Raihan Islam Arnob , Antonios Anastasopoulos , Kevin Moran

Developers interrupting their participation in a project might slowly forget critical information about the code, such as its intended purpose, structure, the impact of external dependencies, and the approach used for implementation.…

Software Engineering · Computer Science 2023-08-29 Dario Amoroso d'Aragona , Luca Pascarella , Andrea Janes , Valentina Lenarduzzi , Rafael Penaloza , Davide Taibi

Good comments help developers understand software faster and provide better maintenance. However, comments are often missing, generally inaccurate, or out of date. Many of these problems can be avoided by automatic comment generation. This…

Software Engineering · Computer Science 2018-10-17 Sergey Matskevich , Colin S. Gordon