High-quality code comments support developers in software maintenance and program comprehension tasks. However, the semi-structured nature of comments, several conventions to write comments, and the lack of quality assessment tools for all aspects of comments make comment evaluation and maintenance a non-trivial problem. To understand the specification of high-quality comments to build effective assessment tools, we emphasize on acquiring a multi-perspective view of the comments, which can be approached by analyzing (1) the academic support for comment quality assessment, (2) developer commenting practices across languages, and (3) developer concerns about comments.To help researchers and developers in building comment quality assessment tools, we contribute: (i) a systematic literature review (SLR) of ten years (2010-2020) of research on assessing comment quality, (ii) a taxonomy of comment quality attributes, (iii) an empirically validated taxonomy of class comment information types (CITs) from three programming languages, (iv) a multi-programming-language approach to automatically identify the CITs, and (v) an empirically validated taxonomy of comment convention-related questions and recommendation from various Q&A forums.Our contributions provide various kinds of empirical evidence of thedeveloper's interest in reducing efforts in the software documentation process, of the limited support developers get in automatically assessing comment quality, and of the challenges they face in writing high-quality comments.
- ISBN:
- 9781678175726
- 9781678175726
-
Category:
- Utilities & tools
- Format:
- Paperback
- Publication Date:
-
22-01-2022
- Language:
- English
- Publisher:
- Lulu Press Inc.
- Country of origin:
- United States
- Dimensions (mm):
- 233.93x155.96x13.46mm
- Weight:
- 0.47kg
This title is in stock with our Australian supplier and should arrive at our Sydney warehouse within 1 - 2 weeks of you placing an order.
Once received into our warehouse we will despatch it to you with a Shipping Notification which includes online tracking.
Please check the estimated delivery times below for your region, for after your order is despatched from our warehouse:
ACT Metro: 2 working days
NSW Metro: 2 working days
NSW Rural: 2-3 working days
NSW Remote: 2-5 working days
NT Metro: 3-6 working days
NT Remote: 4-10 working days
QLD Metro: 2-4 working days
QLD Rural: 2-5 working days
QLD Remote: 2-7 working days
SA Metro: 2-5 working days
SA Rural: 3-6 working days
SA Remote: 3-7 working days
TAS Metro: 3-6 working days
TAS Rural: 3-6 working days
VIC Metro: 2-3 working days
VIC Rural: 2-4 working days
VIC Remote: 2-5 working days
WA Metro: 3-6 working days
WA Rural: 4-8 working days
WA Remote: 4-12 working days
Share This Book: