Code Comments for Quantum Software Development Kits: An Empirical Study on Qiskit
Open Access
- 15 September 2026
- journal article
- Published by Association for Computing Machinery (ACM) in ACM Transactions on Software Engineering and Methodology
Abstract
Quantum computing is gaining attention from academia and industry. With the quantum Software Development Kits (SDKs), programmers can develop quantum software to explore the power of quantum computing. However, programmers may face challenges in understanding quantum software due to the non-intuitive quantum mechanics. To facilitate software development and maintenance, code comments offered in quantum SDKs serve as a natural language explanation of program functionalities and logical flows. Despite their importance, scarce research systematically reports their value and provides constructive guidelines for programmers. To address this gap, our paper focuses on Qiskit, one of the most popular quantum SDKs, and presents CC4Q, the first dataset of code comments for quantum computing. CC4Q incorporates 12,812 code comment pairs and 28,076 sentence-level code comment units, the latter of which involve heavy human annotation. Regarding the annotation, we validate the applicability of the developer-intent taxonomy used in classical programs, and also propose a new taxonomy considering quantum-specific knowledge. We conduct an empirical study comprehensively interpreting code comments from three perspectives: comment structure and coverage, developers’ intentions, and associated quantum topics. Our findings uncover key differences in code comments between classical and quantum software, and also outline quantum-specific knowledge relevant to quantum software development.Keywords
All Related Versions
This publication has 27 references indexed in Scilit:
- An Empirical Study on Self-Admitted Technical Debt in Quantum Software2024
- Distilled GPT for source code summarizationAutomated Software Engineering, 2024
- Bugs4Q: A benchmark of existing bugs to enable controlled testing and debugging studies for quantum programsJournal of Systems and Software, 2023
- Out of the BLEU: How should we assess quality of the Code Generation models?Journal of Systems and Software, 2023
- Bugs4Q: A Benchmark of Real Bugs for Quantum Programs2021
- How to identify class comment types? A multi-language approach for class comment classificationJournal of Systems and Software, 2021
- Toward a Quantum Software EngineeringIT Professional, 2021
- A Neural Model for Generating Natural Language Summaries of Program Subroutines2019
- Classifying Python Code Comments Based on Supervised Learning2018
- Design Science Methodology for Information Systems and Software Engineering2014