The added bonus to writing good comments is you’re practicing technical writing directly associated with your code.
It’s similar to writing your own flash cards, but by rephrasing the code into a comment you’re visually and linguistically using a form of repetition to stick the code inside your head with a human readable explanation. This can make you a better technical communicator when discussing any code with others.
There is a lot more than “I will read this comment in 6 months and it will save my ass” going on when you practice writing good comments.
I really like this because in my opinion, half of my job is good communication, another quarter is planning/design, and the final quarter is actually writing code.
It’s similar to writing your own flash cards, but by rephrasing the code into a comment you’re visually and linguistically using a form of repetition to stick the code inside your head with a human readable explanation. This can make you a better technical communicator when discussing any code with others.
There is a lot more than “I will read this comment in 6 months and it will save my ass” going on when you practice writing good comments.
I really like this because in my opinion, half of my job is good communication, another quarter is planning/design, and the final quarter is actually writing code.