- cross-posted to:
- programmerhumor@lemmy.ml
- cross-posted to:
- programmerhumor@lemmy.ml
You must log in or register to comment.
And I always think I write good comments until a year later I’m like these comments don’t help shit
Try to write as if you are explaining the functionality to an unrelated 3rd party like a new hire.
Yeah, write it for the person who has to replace you when you inevitably get laid off so that your company can hire someone for half your salary.
This is probably more accurate:
-Who the fuck wrote such a shit!
-WHO???
-…
-Oh… it was me…
Me at a previous workplace.
-This is a piece of shit, who is the code owner of this module.
-
Ah, it’s me (“inheriting” code ownership when someone left was common)
-
Who did this change
-
Ah, it was me
-
Surely I just made a minor change to this line here, who wrote the function.
-
it was me, it was me all the way down
Fits the general theme of the thread as it was not giving any trouble for a year before being found.
The more frustrated you are when running
git blamethe more likely the command turns out to be a mirror.This is where the programmer’s way to humbleness starts :-D
-
This is why you’re meant to comment your code.
Your code tells you “what”, your comments tell you “why”.
Here’s a good review of comments in the redis codebase: https://antirez.com/news/124
*yesterday
There’s an exponential amount of time between each panel. 1 hour, 5 hours, 2 days for the answer.
Accurate, except the bottom right panel only happens in very limited circumstances, hardly ever after a year has passed.
Source: I’ve been writing software since 1983 or so.
Sometimes, I just rewrite my code until it is good enough. Other times, I leave it to my memory, so I can figure it out later. And others, I’m just not happy about it, like the times I did bigbin2dec and it would only work well with something like thread-ripper.
