Maybe I'm getting alright at in-code documentation because when my code breaks after months of me not looking at it, I can return and get up to speed in a few minutes.
(or maybe these people are working on much more advanced stuff)
this post was submitted on 17 Jan 2025
699 points (99.2% liked)
Programmer Humor
32910 readers
1002 users here now
Post funny things about programming here! (Or just rant about your favourite programming language.)
Rules:
- Posts must be relevant to programming, programmers, or computer science.
- No NSFW content.
- Jokes must be in good taste. No hate speech, bigotry, etc.
founded 5 years ago
MODERATORS
My coworker with whom I m assigned on a project was off on thursday and friday and I m off on monday. Good luck understanding my autistic ass code. Tee hee
I always leave my project in a state where it doesn't compile or run (not commits, obvs) so I'm forced back into understanding exactly what I was doing when I left off to fix the error.
Even if documentation can be time-consuming, it is such a lifesaver and makes the whole process of coding much smoother. It means not as much time wasted backtracking. If you think there is any part of your code you won't understand when you coming back to it, document, document, document.
Sometimes I write some multiline psuedocode comments or/and an explaination of specific choices, especially those invisible choices you make while debugging that aren't apparent when your just reading through your code.
Good thing to do is make code that is generally readable too lol.
// TODO make this work
Pro tip: Keep a log of your work in a text file. I write a few bullet points for each day and on Friday write a "Next Week" section for my todos on that following Monday. Helps reduce the cognitive load of trying to remember what the hell you were about to do next.
I actually enjoy this part, where I've written some intricate code of sorts and get to spend some time writing a memo that explains how it works.
I usually don't even end up reading them, because the process of writing a good memo will make me remember it.
AKA a WAR, which is an unnecessarily aggressive acronym for "weekly action report."
"Weekly action report!? Oh, that means war for sure"
I write down my current/next thoughts on a Post-It and stick it to my keyboard for Monday Noodle.
I sort of do this in a block comment at the top of some scripts I write.
Changelog for Completed Stuff and Future Features for todo
I secretly have forgotten a lot of the working code I wrote months ago; and whenever someone asks, I need to go back and read it like new
Its always like 3 hours to remember why I was doing what I was doing, just to scrap it because the core is all wrong.
Make up something quickly stand-up is only 30 minutes after starting time
Monday stand-ups are the worst
If only there were some way to leave some sort of ... what's it called a comment maybe 🤔 idk...
/s
/*
look I know this sucks ass but its Friday and I want to go home.
I'll fix it on Monday.
*/
Last committed 2014.
Didn't say which Monday
As is tradition.
Me except it's everyday, and it's my boss's code, so I'm not able to complain 🫠
You can always complain. You're complaining right now.
But I'm smart enough not to do it to my boss.
Or are you? Try it, just a lil 😼
Me coming back to my run of 'luck be a landlord' and trying to figure out what strategy I was even thinking of, when I witness the chaos I left myself as I press 'continue'..
This is so me!