DEV Community

Valery Zinchenko
Valery Zinchenko

Posted on

I put .dots. to End Comments

Hello, this is my once in a century blog post about things I do from my experience.


It happened to me several times:

I was reading my or someone else's comments and the sentence was a bit weird, it felt like it wasn't finished. And just by adding couple of words in the end, the comment could change the meaning drastically.

I know myself, I may start writing a comment and either forget to finish or leave it unfinished intentionally. But my unfinished comments were everywhere, so obviously there should be something to tell me it's not finished.

.

It turned out to be much simpler than I could imagine - I just don't have to do anything! And by not putting a dot in the end, it would indicate me I haven't finished it or just yet to update.

After that I started marking every "finished" comment (by a feel) with a .dot.

And now my code somehow looks more organized. Firstly I was a bit skeptical because I have never seen anyone doing that. But now I'm naturally used to do that since we do it when we write blog posts lol :>

What about others?

I simply treat anyone else's comments as unfinished because it actually may be so. The comments are not something to rely on and the lack of .dot reminds me this once again.

And when I see that my "finished" comment is describing things incorrectly, I know exactly that it was inaccurate rather than "unfinished".

Top comments (0)