How programmers comment their code

Same with BIOS descriptions.

FGTSAB switch [toggles the FGTSAB setting]

infuriating

Best comment ever was "It used to work like this but person at client demanded it work like that on this date" when the client complained it shouldn't work like that.

/*
 * Gets stupidFuckingInteger
 *
 * @returns stupidFuckingInteger
*/
public double getStupidFuckingInteger() {
    return stupidFuckingInteger;
}

//@TODO document this function later

15 years later

Comments should explain "why", the code already explains "what".

I had a old job that told me that code is "self documenting" if you write it "good enough". And that comments were unnecessary.

It always annoyed the heck out of me. Comments are imo more helpful than hurtful typically.

Is it just me? Or am I weird? Lol.

I write such comments because I have to.

Company policy.

Also we have to specify every line of code and what it should do.......

/********** Setting up the fkuArray **********/

fkuArray = array(...

Good code is self-explanatory. You should only comment your code if it does something unexpectedly complicated.

That being said, it's always a good idea to write a manual, about how to use the code. Don't document how it works, because those who can code will understand it anyways, and those who can't, have no need to understand it.

Comment about image

I got a media failed to load error at first and thought that was the joke

The code is self explanatory

/s needed apparently

How bad programmers comment their code. Good programmers don't comment at all and let the code speak for itself, leaving commenting to some obscure and arcane implementation the coder left in after a week long binge on caffeine and gummy bears.

Dankpods screen cap?

A real comment in our junior year game engine codebase.

UEFI feature descriptions.

Fs.?g??yy V>

Our code base is filled with “//constructor”, “//destructor”, “//assignment”, or the ever enlightening “Foo GetFoo(); // GetFoo”.

This is not what they mean by self-documenting code.

At work we let Typescript and descriptive naming document our code. Only when something is a workaround or otherwise weird will we add comments. So far it has worked great for us.

this is why i very rarely comment with descriptive comments. If you're reading my code and don't understand what it is, even with how shit it is, you have no business reading whatever fucking crackpot shit im writing.