Tbf, i always comment my code to do a sanity check of what i am doing along the way( think rubber duck method with comments). The problem is that my writing is so cryptic i am the only one that could ever understand it.
I have to comment my code because otherwise I have no idea wth I was writing 6mo ago.
Like, I recently had to update a script I wrote 2 years ago and had thought 'this is self explanatory, I don’t need to comment it’s only to have me come back and have to walk the code to figure out I forgot to include an edge case that hadn’t occurred yet …
Break it up into functions with names that describe what it does, then the script becomes basically a sequence of function calls and is easier to read and troubleshoot.
This is how I started writing my scripts and it is sublime. Even better is when your function can be a single return statement, makes writing tests easy.
my writing is so cryptic i am the only one that could ever understand it.
That sounds like my handwriting. And If written in a hurry, even I struggle to make sense of the mix of runes, hieroglyphics and child’s drawings I call my “cursive”.
my handwriting it’s exactly like that. Doesn’t help that i am left handed and smudge the shit out of the paper. But what i meant was the “oogabooga” caveman level of comments i add to code. You’ll be lucky to find a cohesive sentence in them. Ex: “check for x if exists, assume setup is done”
Tbf, i always comment my code to do a sanity check of what i am doing along the way( think rubber duck method with comments). The problem is that my writing is so cryptic i am the only one that could ever understand it.
I have to comment my code because otherwise I have no idea wth I was writing 6mo ago.
Like, I recently had to update a script I wrote 2 years ago and had thought 'this is self explanatory, I don’t need to comment it’s only to have me come back and have to walk the code to figure out I forgot to include an edge case that hadn’t occurred yet …
Break it up into functions with names that describe what it does, then the script becomes basically a sequence of function calls and is easier to read and troubleshoot.
This is how I started writing my scripts and it is sublime. Even better is when your function can be a single return statement, makes writing tests easy.
I’m on your side dude. Comments rot. Some are useless. Don’t even get me started on doxygen comments.
6 months - you’re good. 3 for me. 😄
That sounds like my handwriting. And If written in a hurry, even I struggle to make sense of the mix of runes, hieroglyphics and child’s drawings I call my “cursive”.
my handwriting it’s exactly like that. Doesn’t help that i am left handed and smudge the shit out of the paper. But what i meant was the “oogabooga” caveman level of comments i add to code. You’ll be lucky to find a cohesive sentence in them. Ex: “check for x if exists, assume setup is done”
Yeah, I know it was unrelated. And I’m sorry for high-jacking your comment.
Just thought I’d add my own little “funny” when it came to writing. :)
sounds like you’re writing code twice lmao
Ah, “cursive”, where half of the letters aren’t actually cursive, and a quarter of the rest actually resemble the actual letter it’s supposed to be.
I hate reading my handwriting.