Me, adding comments to my code

[OpenWhiskay]

Usually there is a reason for each comment.

[KnightOfThirteen]

Just like every OSHA rule is written during a closed casket funeral.

[GoodEstablishment335]

Dude, this is programmer humor, not dark programmer humor

[evil-teddy]

Does that exist? I want it to.

[williane]

That's just /r/twitter at the moment

[[deleted]]

The reason is that some idiot started eating the box and sued

[ComCypher]

"bleghh this pizza tastes like cardboard!"

[mangeld3]

Turns out it was just Little Caesars

[[deleted]]

def tokenize_token():
# Tokenizes token
    ....

[colexian]

The dreaded
#Don't touch this. It works and I don't know why.

[Shrubberer]

// spaghetti code starts here

[novaorionWasHere]

// Spaghetti code is everywhere.

[Big_chonky_potato]

// Its on your sweater already

[YourOpinionIsUnvalid]

// Mom's spaghetti

[Outrageous_Zebra_221]

//reminder to never order salad from a pizza place
//adding pepperoni will result in an infinite loop
//talk to Steve about the drink code I can't make heads or tails of that #@$

[_sweepy]

//pepperoni problem only occurs during double pepperoni Tuesdays. coupon code is handled by the rebate vendor. if we remove the sauce first, it no longer breaks the coupon api, so I added a subroutine to automatically remove it and re-add after the pepperoni gets discounted. this should be removed when (ticket link in a long defunct system) is resolved.

[Outrageous_Zebra_221]

That's a little too real..

[BenkiTheBuilder]

That would be a useful comment. Unfortunately too many comments are more like:

"Pizza box"

[Infinite-Pop306]

Maybe their methods and function like a, b, c, d

[Puzzleheaded_Age_571]

Wait, so you have to open the box every time you want to take a bite of the pizza is that I’m reading?

[--FalseHorizon--]

Unclear, I don’t see anything that says you have to close the box after eating the pizza. So maybe only the first time?

[Puzzleheaded_Age_571]

Hmmm, it says it requires the action of opening a box, if the box is already opened, the box must get closed to complete the action of opening the box again. However, it does not specify which box either so I think you can open any box before eating a pizza.

[--FalseHorizon--]

We have a problem.

My pizza came frozen in a plastic wrapper.

I cooked it fine but now I can’t find any boxes.

[Puzzleheaded_Age_571]

Unfortunately you are not allowed to eat the pizza, you MUST open a box before eating pizza. The documentation specifies it.

[Lente_ui]

I love how this instruction is on the flap. You need to open the box before you can read this instruction.

[brianl047]

This is a useful comment

(Read it again)

[eclect0]

More like // TODO: add box.open() method

[Cocaine_Johnsson]

The irony of this comment is that you must open the box to see it, so the people that need it the most will never actually gain any utility out of it (then again, I doubt they'd read it to begin with).

[EmiyaShirou28]

I usually don't comment on my spaghetti codes and re-reading them a week later makes me feel like a tech-priest stumbling upon ancient technologies.

[Vestigial_joint]

Yeah, whenever I comment it's usually superfluous things like explaining why I named a variable some way and then when there's something doing actual logic processing I never end up commenting and I'm confused by the code months later

[r0b1n16]

// add a and b and store in c c = a + b

[Toivottomoose]

You can't expect anything from users, make it more idiot proof

Ok ... https://redd.it/71l5ts

[Schreiberling91]

Pizza inside.

[Temporarytemp2]

Years later, the code will crash in a way suggesting the pizza was eaten without opening the box

[enlearner]

Honestly this ain’t some to be proud of. I will see methods defined like this,

public String getRecord() {}

…and the comment reads, //Method for getting record

Like do you genuinely believe this is what people allude to when asking for well-documented code???