Abstract
Use comments with care. The 5-line Boolean function below is my revision of 13 lines of code with nine more comment lines. The longer version was an Internet instructor’s example, with the direction to comment nearly every line of code (terrible idea, even for beginners). Self-documentation is better.
This is a preview of subscription content, log in via an institution to check access.
Access this chapter
Tax calculation will be finalised at checkout
Purchases are for personal use only
Notes
- 1.
Steven S. Skiena (Stony Brook) and Miguel A. Revilla (Valladolis, Spain), Programming Challenges (Springer, 2003), page 9. Today this is called CDD (comment driven development).
- 2.
Steven S. Skiena and Miguel A. Revilla, Programming Challenges (Springer, 2003), page 40.
Author information
Authors and Affiliations
Rights and permissions
Copyright information
© 2018 Michael Stueben
About this chapter
Cite this chapter
Stueben, M. (2018). Comments. In: Good Habits for Great Coding. Apress, Berkeley, CA. https://doi.org/10.1007/978-1-4842-3459-4_8
Download citation
DOI: https://doi.org/10.1007/978-1-4842-3459-4_8
Published:
Publisher Name: Apress, Berkeley, CA
Print ISBN: 978-1-4842-3458-7
Online ISBN: 978-1-4842-3459-4
eBook Packages: Professional and Applied ComputingApress Access BooksProfessional and Applied Computing (R0)