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.

[–] [email protected] 27 points 2 weeks ago (2 children)

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 ..

[–] [email protected] 12 points 2 weeks ago (3 children)

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.

[–] [email protected] 9 points 2 weeks ago* (last edited 2 weeks ago)

Yeah I dont know why people dont do this. Then an overall description of the script at the top is enough and anyone can just look at function names to see what is going on.

[–] [email protected] 6 points 2 weeks ago

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.

[–] jkercher 2 points 2 weeks ago

I'm on your side dude. Comments rot. Some are useless. Don't even get me started on doxygen comments.

[–] [email protected] 2 points 2 weeks ago

6 months - you're good. 3 for me. 😄

[–] [email protected] 15 points 2 weeks ago* (last edited 2 weeks ago) (2 children)

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".

[–] [email protected] 7 points 2 weeks ago* (last edited 2 weeks ago) (2 children)

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"

[–] [email protected] 2 points 2 weeks ago

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. :)

[–] [email protected] 1 points 2 weeks ago

sounds like you're writing code twice lmao

[–] [email protected] 5 points 2 weeks ago (1 children)

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.

[–] [email protected] 1 points 2 weeks ago

I stopped using cursive my sophomore year of high school. Started using smallcaps, and everyone was happier.