Composing Compelling Code Comments (Part 1) – "I don't need to write comments"
Are you interested in learning how to write great comments for your code when programming?
This video guide is not focused on a specific programming language or platform, but can instead be watched by anyone developing software – regardless if it is JavaScript, Python, Java, C#, Rust, Kotlin, or just about any other language that supports code comments!
In this first episode of my series "Composing Compelling Code Comments", I am highlighting why some developers refuse to add comments to their source code and I am going to debunk each of the commonly given four arguments:
“They don’t add any value“
“My code is self-documenting”
“They get out of date“
“I have no time to write them“
Most of these points are at least largely irrelevant when instead considering what benefits writing code comments can bring for you as a software engineer as well as for your team as a whole to improve your in-code documentation.
Please note that my series "Composing Compelling Code Comments" is based on personal experiences as well as publicly available books, most prominently "A Philosophy of Software Design" by John Ousterhout and "Clean Code" by Robert C. Martin.
You can support my channel by buying said books via these links, in case you are interested:
Amazon.com:
"A Philosophy of Software Design": https://amzn.to/2WqKzby
"Clean Code": https://amzn.to/3ifs6q1
Amazon.de:
"A Philosophy of Software Design": https://amzn.to/3icxudh
"Clean Code": https://amzn.to/39LtFaz
Amazon.co.uk:
"A Philosophy of Software Design": https://amzn.to/3ASBLKf
"Clean Code": https://amzn.to/3idZCg8
If you have any suggestions for content or feedback please leave them in the comments.
In case you enjoyed this video, make sure to leave like, subscribe and share it with anyone you could consider interested!