Composing Compelling Code Comments: "I don't need to write comments, my code is self-documenting"

#comments #commenting #documentation #softwareengineering

Composing Compelling Code 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!

Here's the link to the video: https://youtu.be/eCnJW2n0vCA

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.

Amplify your impact where it matters most — building exceptional apps.

Leave the infrastructure headaches to us, while you focus on pushing boundaries, realizing your vision, and making a lasting impression on your users.

Get Started

Top comments (0)

Hate writing docs?

Hate undocumented APIs even more?

Bump.sh generates an always up-to-date API reference site for REST and Event-Driven Architectures.

Plug it in your CI. It fetches your OpenAPI and AsyncAPI (GraphQL pending) spec files, and even generates a diff. Gather all of your API docs in a single source of truth.

Try it for free