TODO: Write Good Code Comments #Shorts

The best comments explain WHY your code exists, not what it does

#code #comedy #shorts

[someonerandom]

The ending comment for those of you who are curious.

// At this point, I'd like to take a moment to speak to you about the Adobe PSD format.
// PSD is not a good format. PSD is not even a bad format. Calling it such would be an
// insult to other bad formats, such as PCX or JPEG. No, PSD is an abysmal format. Having
// worked on this code for several weeks now, my hate for PSD has grown to a raging fire
// that burns with the fierce passion of a million suns.
// If there are two different ways of doing something, PSD will do both, in different
// places. It will then make up three more ways no sane human would think of, and do those
// too. PSD makes inconsistency an art form. Why, for instance, did it suddenly decide
// that *these* particular chunks should be aligned to four bytes, and that this alignement (alignment)
// should *not* be included in the size? Other chunks in other places are either unaligned,
// or aligned with the alignment included in the size. Here, though, it is not included.
// Either one of these three behaviours would be fine. A sane format would pick one. PSD,
// of course, uses all three, and more.
// Trying to get data out of a PSD file is like trying to find something in the attic of
// your eccentric old uncle who died in a freak freshwater shark attack on his 58th
// birthday. That last detail may not be important for the purposes of the simile, but
// at this point I am spending a lot of time imagining amusing fates for the people
// responsible for this Rube Goldberg of a file format.
// Earlier, I tried to get a hold of the latest specs for the PSD file format. To do this,
// I had to apply to them for permission to apply to them to have them consider sending
// me this sacred tome. This would have involved faxing them a copy of some document or
// other, probably signed in blood. I can only imagine that they make this process so
// difficult because they are intensely ashamed of having created this abomination. I
// was naturally not gullible enough to go through with this procedure, but if I had done
// so, I would have printed out every single page of the spec, and set them all on fire.
// Were it within my power, I would gather every single copy of those specs, and launch
// them on a spaceship directly into the sun.
//
// PSD is not my favourite () file format.

[giripriyadarshan]

/* don't remove this ( doesn't compile without this).
Nobody knows what this does */

[maximcoppieters]

// When I started writing this, only God and I understood what I was doing
// Now, only God knows

[_modiX]

// sometimes I believe compiler ignores all my comments

[ninjaz]

// The last person who wrote this didn't know what they were doing
// You probably don't either

[wisdomcube]

The best one ive seen so far is on team fortress source code...somehow there was a comment on a code that links to a picture of a coconut and it says "i dont know what this does but somehow the game wont load if i delete this, words cannot express my confusion"....till this day it always makes me laugh..

[vitalino]

Man I laughed through tears 😂 on "hours wasted" counter 😆

[itsbk]

I read the entire PSD rant and oh god 😂 PSD sounds like it set his house on fire and blamed his mom for a loud fart in a theatre

[danvilela]

My favorite was when i was a firmware engineer prograaming in C:
#define EIGHT 8
The guy was a genius

[Fireship]

Ever come across a funny code comment at work? Do tell...

[lablnet]

// just paste from stack overflow
// It's working but don't know how.

[Johnny]

My favorite was when we had around a hundred line of "commented out" code that if we removed would break our site lol...

[itzmeB]

"psd is not my favorite file format" 😂😂😂

[NN-kfqo]

"You want comments? My code is self-explanatory, no need for me to comment." Heard it too many times from people just trying to become irreplaceable instead of sharing knowledge.

[氷語]

“Your teammates don’t want to know what your code does, they want to know why its breaking the build.”

[btarg]

The comments in the TF2 Source Code Leak, and the leak of Windows XP, were all pretty damn hilarious. You really get an insight into the horrors of working on a massive project using a legacy codebase.

[oShinobu]

I've never worked with PSD files but that last comment is so relatable

[tapu_]

All my code comments are about rage over my past self.

[stevesajeev]

The most brilliant person wrote the counter for hours wasted. Who else will ever find a better use for comments.😁

[GetAnswerly]

"good developers don't need to comment their code" is a bad mindset that shouldn't be pushed. Everyone needs to do their colleagues and themselves from the future a favor and comment their code.