Stop writing bad comments in your code — Tips for Clean Code | by Kyle Le | Level Up Coding

Introduction

Stop writing bad comments in your code — Tips for Clean Code Kyle Le 3 min read · Nov 17, 2022 -- 4 Listen Share Press enter or click to view image in full size Stop comment out your code please Introduction Comments are actually very useful in programming if they are well-placed. But most of the time comments are not that “good”. Bad comments can lead to misinformation, wasting time, create bad habits, etc. In this article, I will guide you how to avoid writing bad comments Bad Comments Out-of-date comments Comments that have gotten old, obsolete, irrelevant or provide wrong information. Comm

related reading

• Things You Should Never Do, Part I – Joel on Softwarejoelonsoftware.com
• Google Testing Blog: Less Is More: Principles for Simple Commentstesting.googleblog.com
• GitHub - johnousterhout/aposd-vs-clean-code: A discussion between John Ousterhout and Robert Martin about differences between John's book "A Philosophy of Software Design" and Bob's book "Clean Code". · GitHubgithub.com
• Some thoughts on writingdanluu.com
• A Bunch of Programming Advice I'd Give To Myself 15 Years Ago | Marcus' Blogmbuffett.com
• Google Testing Blog: Code Health: Too Many Comments on Your Code Reviews?testing.googleblog.com
• Repeat yourself, do more than one thing, and... — programming is terribleprogrammingisterrible.com
• Writing commit messageschiark.greenend.org.uk
• Here’s how I use LLMs to help me write codesimonwillison.net
• How to Write a Git Commit Messagecbea.ms
• Three Sins of Authors in Computer Science and Mathcs.cmu.edu
• Google Testing Blog: Code Healthtesting.googleblog.com