685
fuck you bill (lemy.lol)
you are viewing a single comment's thread
view the rest of the comments
[-] NotAnonymousAtAll@feddit.org 8 points 1 month ago

Excellent comment and I fully agree with almost everything. Just one tiny nitpick:

For example if I have some sort of complex calculation, but it’s based on a well known algorithm, I might comment the name of that algorithm.

Unless you really need this complex calculation to be inline (e.g. for performance reasons) it would be better to move it into a function or method and include the algorithm in the name instead of adding a comment.

[-] Thorry@feddit.org 3 points 1 month ago

Very good! Your spidey senses are working perfectly. Hey I want to comment this calculation, why don't I move it into a function so the name can explain what it does. Good call!

Sometimes the algorithm is inlined for performance, sometimes it's a class with a bunch of functions that as a whole is primarily based on an algorithm, so comments might make sense in those cases. Most of the times it's a library, so the name of the library kinda gives it away and hopefully has good documentation as well.

this post was submitted on 17 Apr 2026
685 points (100.0% liked)

Programmer Humor

31455 readers
2013 users here now

Welcome to Programmer Humor!

This is a place where you can post jokes, memes, humor, etc. related to programming!

For sharing awful code theres also Programming Horror.

Rules

founded 2 years ago
MODERATORS