Document your code like the guy who will be maintaining it is Dexter, and he knows where you live.
this post was submitted on 02 Aug 2024
338 points (96.9% liked)
Programmer Humor
32361 readers
1025 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
// This function calculates applicable discounts given a customer's loyalty status
// STOP BEFORE SEASON 8 DEXTER PLEASE
fun calculateDiscountRate(loyalty: LoyaltyStatus): Set<Discount> {
// No seriously you can hide out at my place if you need to just please don't let them do it
...
That ... at the end made me think there was more code and my client was refusing to show it to me no matter what I did.
And don't watch that new dexter spin off
Is this going to activate the StarGate?
Only one way to find out
Excuse me, but my indecipherable hieroglyphics at least use proper indentation.
Right. And what do you mean my RegEx is not exhaustive enough and now the database is filled with garbage data?
I get this one so much. I don't consider myself a developer because I tend to just touch code but that means I won't touch any for weeks. Worse I tend to do a lot of poc or boot strapping type of things and so its like there was a user story last pi to check the feasibility of something and now have a user story to get it regularly working in a poc env and I have forgotten everything about that particular system or language or whatever.
That's why we keep notes... Literate DevOps is a solution for my preferred editor, but there definitely are solutions for other tools too, even if they don't work exactly the same.
I can't recommend keeping notes too much.
I mean thats great but finding the notes is always a chore to because so much has been done between now and then and there are a lot of stuff done with their own notes. We are actually required to document in like 3 different ways although we don't need to do all 3 all the time. informal, formal internal, formal customer.
I'm not going to argue, because I don't know your work environment, but the notes I mentioned weren't supposed to be published or attached to the product. They're more of a personal knowledge base, where you can look up former approaches, issues found in the past, reasoning, decisions with context... All the zettelkasten tools out there do exactly that: help maintaining a useful knowledge base.
U mean yesterday
If I get off my computer for an hour and come back I'm already unable to recognize my code lol
this resonates so much...
"ok, which one of you crackheads decided an unconstrained recursive C function was a good idea right her... oh."
this was me while writing my website for my screen and media course, I come back a week later and try to interpret these ancient runes inscribed on my IDE, had to stare at it for like half an hour to finally get what I made.