Pun of the day

Boss: I heard your colleagues hate dealing with code you wrote. Why?
Me: No comment

Code comments be like....

"I wrote the code, I have to maintain the code, I wont need any comments"

*some months later*

I found the greatest stackoverflow comment:

Debugging comments be like...

Comment your own code.

"But nobody except me will see..."

COMMENT YOUR OWN CODE!!!

The way to resolve the issues

Hope I'm not late with this one.

Oh, man, I just realized I haven't ranted one of my best stories on here!

So, here goes!

A few years back the company I work for was contacted by an older client regarding a new project.

The guy was now pitching to build the website for the Parliament of another country (not gonna name it, NDAs and stuff), and was planning on outsourcing the development, as he had no team and he was only aiming on taking care of the client service/project management side of the project.

Out of principle (and also to preserve our mental integrity), we have purposely avoided working with government bodies of any kind, in any country, but he was a friend of our CEO and pleaded until we singed on board.

Now, the project itself was way bigger than we expected, as the wanted more of an internal CRM, centralized document archive, event management, internal planning, multiple interfaced, role based access restricted monster of an administration interface, complete with regular user website, also packed with all kind of features, dashboards and so on.

Long story short, a lot bigger than what we were expecting based on the initial brief.

The development period was hell. New features were coming in on a weekly basis. Already implemented functionality was constantly being changed or redefined. No requests we ever made about clarifications and/or materials or information were ever answered on time.

They also somehow bullied the guy that brought us the project into also including the data migration from the old website into the new one we were building and we somehow ended up having to extract meaningful, formatted, sanitized content parsing static HTML files and connecting them to download-able files (almost every page in the old website had files available to download) we needed to also include in a sane way.

Now, don't think the files were simple URL paths we can trace to a folder/file path, oh no!!! The links were some form of hash combination that had to be exploded and tested against some king of database relationship tables that only had hashed indexes relating to other tables, that also only had hashed indexes relating to some other tables that kept a database of the website pages HTML file naming. So what we had to do is identify the files based on a combination of hashed indexes and re-hashed HTML file names that in the end would give us a filename for a real file that we had to then search for inside a list of over 20 folders not related to one another.

So we did this. Created a script that processed the hell out of over 10000 HTML files, database entries and files and re-indexed and re-named all this shit into a meaningful database of sane data and well organized files.

So, with this we were nearing the finish line for the project, which by now exceeded the estimated time by over to times.

We test everything, retest it all again for good measure, pack everything up for deployment, simulate on a staging environment, give the final client access to the staging version, get them to accept that all requirements are met, finish writing the documentation for the codebase, write detailed deployment procedure, include some automation and testing tools also for good measure, recommend production setup, hardware specs, software versions, server side optimization like caching, load balancing and all that we could think would ever be useful, all with more documentation and instructions.

As the project was built on PHP/MySQL (as requested), we recommended a Linux environment for production. Oh, I forgot to tell you that over the development period they kept asking us to also include steps for Windows procedures along with our regular documentation. Was a bit strange, but we added it in there just so we can finish and close the damn project.

So, we send them all the above and go get drunk as fuck in celebration of getting rid of them once and for all...

Next day: hung over, I get to the office, open my laptop and see on new email. I only had the one new mail, so I open it to see what it's about.

Lo and behold! The fuckers over in the other country that called themselves "IT guys", and were the ones making all the changes and additions to our requirements, were not capable enough to follow step by step instructions in order to deploy the project on their servers!!!

[Continues in the comments]

College was a hell lot of fun.

Every. Single. Time.

Protip: always check for snarky comments before pushing

Lol 😜😜😂😂

Some comments are helpful, some aren't

You can find some golden comments deep inside github repos 😂

Shout out to devs who put comments in your code I'm so done with my team rn

Also we have slack for a reason stop texting me to update everyone on changes...

Had a PR blocked yesterday. Oh god, have I introduced a memory leak? Have I not added unit tests? Is there a bug? What horrible thing have I unknowingly done?

... added comments to some code.

Yep apparently “our code needs to be readable without comments, please remove them”.

Time to move on, no signs of intelligent life here.

Comments it out and flies away..

So my GF's studying C#. Some things they learn are actually true 🙈

Couple years ago, I wrote a game in assembly.
Yesterday, I tried to look at the source, and realised there isn't a single fucking comment.

You know what really grinds my gears?

Seeing a 5-line comment, that have absolute no value, for a variable declaration.

Example:

/*
*
* String that holds a delivery address.
*
*/
public String deliveryAddress;

After opening the legacy code and finding out that the entire shit has 15000+ LOC and without proper comments

When someone asks you to add more comments to your clean code.

True story

I sometimes write code by first putting comments and then writing the code.
Example
#fetch data
#apply optimization
#send data back to server
Then i put the code in-between the comments so that i can understand the flow.
Anyone else has this habit?

Told ya!

Code never lies..

When you properly comment your code.

Where do I buy this?

//Salt

Stack overflow is really gold sometimes!

Writes program.
Doesn't comment code.
*Yeah totally gonna remember everything* 🕶

*5 weeks later*
what the heck was I writing.? 🙄😥😭

Why I love devRant so much?

Unlike other communities we are not abusing picture comments :)

When you check the comments under GitHub and most of them are +1

When I decided to comment my code

“Ahh fuck it, no time for adding comments and I will remember how all of it works anyways.”

No wonder my installer doesn't work...

Lol true

Was just browsing through some old screenshots when suddenly...

Commenting for future reference

Code never lies... Comments sometimes do... 💻💻

Just downloaded some big ass codebase and the first line i read is:

"// The source code is not well documented, but every advanced programmer will be able to understand it after some time."

Well... let's find out about your definition of "some time", Dickhead!

Shouldn't be necessary if you just write understandable code xD..... Some people just write stories in between 2 lines of code....

Anybody else here has a coworker who insists on having comments everywhere and writes code like this?

// Get foo
foo = getFoo();

// Check if foo is greater than bar
if (foo > bar)

Or is it just me?

This is true.

My coworker comments every line of code I think the code is not readable!

Unpopular opinion: I like documenting my code. I think it has a somewhat calming effect

I hate myself. Really.
Last week I wrote a function to handle file uploads and at some point I left this very useful comment.
Do I know what to fix? Absolutely fucking nope.
I want to punch me from last week in the face

Be me, and write a reminder down with a // in front of it.
On a piece of paper.

Today I created my first public repo... I've never commented my code so much.

No need of comments!

I promise (for myself) I'll comment my code from now on...

When Its 4PM and you're trying to read the Code you wrote at 3AM.

So I saw a guy looking frustrated today, staring at a big wall of code that he needs to debug.
A 3000 lines file, of only 2 methods, with variables named using single characters, and 0 comments except for 1 right in the middle of the file.

//now we average

I usually offer help, but this is something I had to run away from :(

Always comment your code.

The proper use of comments is to compensate for our failure to express ourself in code.

Quote of the book "Clean Code" by "Uncle Bob".

#ShotsFired

The comment on the source code of hasthelargehardroncolliderdestroyedtheworldyet.com is the best one I've seen so far :D

!rant

Someone just downvoted four of my answers on Stackoverflow just because I commented on one of his answers that "please include some description, just code won't be helpful"

PEOPLE IF YOU CAN'T ACCEPT YOU ARE WRONG THEN GET THE FUCK OUT FROM OUR COMMUNITY AND STOP RUINING IT.

Another stack overflow rant.

I had a disagreement with a self proclaimed "high repper" last night. We exchanged words in the comments of one of my questions.

Later (about ten mins) i see that another one of my questions has been closed and marked as duplicate - by this same fuck-knuckle. He has obviously gone to my profile and then gone out of his way to harass / bully me by doing this.

The 2 questions are absolutely not duplicates and he has marked them as identical.

I go to his profile and his headline thing is

"Low reppers hate closers but they need to go bitch about it elsewhere"

If anyone on here doesn't understand why SO gets a bad rap, it's specifically due to complete cunts like this guy.

If you happen to be on here and recognise yourself from the really cringy "low reppers" comment on your profile, then all I have to say to you is that you are a complete an utter ballbag; a tool; an arsehole of the highest order.

Fuck you and all your spawn.

print ("Hello World") # prints hello world

"A common fallacy is to assume authors of incomprehensible code will be able to express themselves clearly in comments" -Kevlin Henney

This had to be shared

Shared by codechef on their Facebook page. Not sure who the original author.

But it sure does make a pretty good header for your code. ;)

#DontMessWithMyCode

A brave soul.

Code never lies. Comments sometime do.

Our PM found a contractor, results as expected..

Contractor: "The file you supplied is corrupt, some areas are greyed out and damaged"
Me: "😐, do you mean the comments?"
Contractor: "I'm not sure what you mean 'the comments'"
Me: "Does the file work as expected?"
Contractor: "Yes"
Me: "Strange! I'll have a chat with our PM and get this issue resolved right away 😉"

...

if(!contractor) {
return Promise.resolve()
}

Someone just asked me to properly indent my code and add comments.
feeling molested.

If you're gonna comment a lot or a little, at least be consistent. I just read some code like this:

//prints "are you ready?"
printf("are you ready?");

//get the value
int findVal(int x) {
/* some fucking complex algorithm with no comments whatsoever that seems to have an error messing everything up */
}

This is how most comments in code are. Why are you telling me it's a coffee cup, I can fucking see it's a coffee cup, who owns it and why is it right here? Are you putting coffee in it or something else?

Sometimes I go ridiculously hardball on my comments in order to gain a better understanding of what I'm trying to accomplish

@dfox
Feature request for favouriting a comment.

Some comments are really helpful/awesome.

I worked with this guy at a startup one time, and just to annoy me, he would write commit comments describing how I was such a bad developer, or how I was such a horrible person. After like the 15th time he did this, I decided to be totally unprofessional and do the same for him... our commit comments quickly turned into a conversation where we would just insult each other (as a joke).

The original developers of the startup no longer work there (including me and him)... I wonder who's reading those comments now.

I love updated comments. ☕

Hi guys,
I did disappear à long time, you know personal problems...
But I'm back to work now, and I was watching cppcon, when...

I just finish "rebuilding" a page that I have built last year. My Js file (jQuery) went from 1200+ lines to 600..

I rewrite everything, the functionality is the same but the code is mush more cleaner.
Soo bad and redundant code.

Although comments where very helpful.

Feels good.

my own program is confusing me :)

it'll be fun waking up tomorrow trying to solve a hard problem…

oh shit i forgot to add comments🙃

When my coworker doesn't want to believe his code is inconsistent, yet he changes the syntax for commenting 3 times over 10 lines.

Writing comments done right by udacity

/**
* We couldn't come up with a good name for this class. Then, we realized
* that this lesson is about RecyclerView.
*
* RecyclerView... Recycling... Saving the planet? Being green? Anyone?
* #crickets
*
* Avoid unnecessary garbage collection by using RecyclerView and ViewHolders.
*
* If you don't like our puns, we named this Adapter GreenAdapter because its
* contents are green.
*/

I am sure this has happened to all of us in some extent with some variations.

Colleague not writing comments on code.
Ask him something like "How am I suppose understand that piece of garbage you have written when there is no comments or documentation?"
This keeps happening for a long time. Some time after, I write a kernel module using idiomatic C and ASM blocks for optimizations (for some RTOS) and purposely not write neither documentation nor comments.
When he asked for an explanation, I answered to everything he questioned as general as I could for "that trivial piece of code".
After that he always documents his code!
Win! 🏆

After reading those comments, everything starts making sense

When I return to development of my code that wasn’t commented

Inner Peace!

Add no comments or documentations whatsoever during my initial years of coding (when actually I used to write code worse than a constipated elephant's shit).. In my mind I would be like "This is quite clear-cut.. A first grader will be able to understand this code.."

But then I had to debug my own code barely some 1-2 months later and I figured out the importance of good comments and documentation..

Fuck the way comments work in xml. I want to write a 2 word comment but before that I apparently have to make an ascii art mona lisa. Infront of and after the comment.

THE ULTIMATE BERMUDA TRIANGLE OF A CODER

Oddly satisfying devRant +1s

Comments should describe the why and not the what and always be up to date ... or this will be the result.

literally lol'd out loud when I saw this. Found in the source of popular event loop library libev, in ev.c line 214:

The one who said "Code should comment itself" must not have used assembly.

I literally wrote this 30 seconds ago and I can't work out what it does now...

¯\_(ツ)_/¯

getting rid of legacy code - and a great comment :D

Looking thru some old code, i lol'd

Inherited project from another company that the owner wants updated rather than rebuilt.

The comments could write a programmers joke book as you can tell it's been passed between multiple developers.

This is a literal excerpt
//Not sure why this line needs to be here but it breaks without it
//Nope I don't know either
//FFS now I have to deal with this. Thanks guys :/

Who the fuck writes 2k lines of code without a single fucking comment!?

When you're severely tired of your life

Comments always lie

So my co-worker loves to tell us to comment our code, for obvious reasons.

But now I'm debugging his code, and guess what.

No comments.

Okay, maybe two comments in two different queries, but they were not that helpfull.

So now I have to debug his code, and I have no idea what I'm even supposed to look for!

After realizing how life-saving commenting is..

When you get to work Monday morning and realise just how little fucks you gave on Friday.

Do you know what kind of shit fucks become HR?

Those who use hashtags in comments for most ridiculous words.

'Hey! I was wondering who all are glad... Only if more people use #Glad, it would be easier for me to figure out this critical information'

that moment when one of your comments have more ++'s than most of your rants! 😂

There are still old youtube comments from my younger self to be found on youtube. Delete every evidence!

Friend - could you comment your code, so I can review it pls.

Me - *comments "gets shit done" ,
"Does some shit ",
"I really don't like commenting my code "

Commented all of my code. More than 1000 lines, teacher didn't read it....

Wanted to search something in my old code. Understood why people use comments.. :/

Me: Can you do the javadocs comments
Coworker: I've never done that, *looks for it on google*, I can't do it, I don't know how.
Me: Did no one asked you to comment you code at school?
Coworker: Yeah, but only the ones with '//'
Me: Ok, bring me coffee

Is it normal for every stupid, arrogant, selfish person to talk all kinds of bad stuff about my app and attack me personally on the play store? It's just a soundboard and it's free you pricks, be grateful for once and don't mind the god damn ads so much. I can't believe that shit.

Lol. Comments have been proved as saviours.

Don't you hate it when you come across a old internet argument but one of the people deleted all of their posts so now you just see a bunch of out of context replies.

A comment line can save the sanity of many programmers

Please remember that comments in html do not start with //. This comes from the website of one of the most important gas and electricity distributor in Italy btw...

I have a coworker who comments every line of code he writes and it doesn't matter how simple the code is and it drives me crazy when I have to look at it. A real life example:

// Gets the total length of the server name string
var total = serverName.length;

Code reviewer keeps removing my comments saying, "This will only be read by other programmers, the code should speak for itself".

<hyperbole>
This is the exact opposite to back in uni where for every line of code they demanded 2 lines of comments!
</hyperbole>

“Good comments explain why, not what,” says Andy Marks. “Do more of the former and none of the latter. A well named method or variable will beat a well-written comment every day.”

When you add comments and your code isn't working so you just leave it alone for 2 hours and when you come back it works

gotta love them comments:
#TODO: move this,
#TODO: deprecated,
#TODO: fix this,
#TODO: DON'T DO THIS,
#TODO: refactor,
#TODO: CHANGE THIS

I shit you not

Your favourite comment?

My team was working on a legacy system, one part of it is an assistant, sadly required as global variables.

Being a non-english-first-language company, some dev years ago thought shortening said assistant to "ass" would be a wise idea - less to type, right?

When we redid the application 2016 part-by-part, our code needed to define 3-4 global variables starting with the "ass" prefix for the legacy parts to work. The colleague who was tasked with this is a fine gentleman from England.

Later as I read through the commit, I found 5 lines of code following 20 lines of comments explaining and deeply apologizing for "ass", "ass_open", etc.

The same dev also had a "HACK OF THE YEAR" comment he moved around when time constraints made a less-than-optimal fix necessary which was worse than the last "highscore".

I don't know why I was reading it, but I loved it :P

Is it bad practice to comment almost every line and every function of your code?

6 lines of comments.
7 lines of code.

Gr8...

Fuck man. I keep forgetting to comment my code for the sake of my future self.

Achievement of the day: I managed to use "begotten" in a comment :)

Boss: Why have you commented out these lines of code?

Me: I don't have the heart to KILL them..

Haven't coded for a few days, returned to my github project to find one of my co-workers has gone through every single line in all of the scripts and added passive-agrresivd, sarcastic, comments about what they do.

Thanks.... I guess....

I'm curious: which do you like better? Atom or VS Code?

Sometimes I write so many comments that it's hard for me to read the code :/

/*Why this website does not use slashes to the front of all the comments on a rant is beyond me!*/

Back then when I was working on a website logic, I didn't want to comment my code. Despite that, I wrote some things which were obvious and I thought it would be funny to explain obvious things in code. I made a joke out of commenting.
Recently I needed to use a part of the code for a different project and the comments were exceptionally helpful and I would be lost without it.

So, kids, comment your code!

Meanwhile in C++ world....
My friend wrote a class and he wrote main to demo how to use it.
He is the nicest programmer I've ever seen...😀

Should I be concerned?

I just started commenting my code. I know, its horrible i havent done this earlier..
I actually enjoy it now, i can express rage, write small jokes for myself to read next time i gotta edit the code, or just remind myself how fucking stupid i used to be

I let my programming buddy comment all the code I write. He's great. His comments looks like this:
/*
I am groot!
*/

Code never lies but comments do !

"There are only two hard things in Computer Science: cache invalidation, naming things, and off-by-one errors."

When you find a 'TODO' comment deep in a crucial function, that you know have been there for at least 5 years. :S

I Remember what my senior told me once:

"You know you're in the wrong job when you see source code filled with comments written by ur senior dev scolding other devs for code fuckups"

Everything is clear now

Code comments #1: A way to document bad code that wasn't reduced to it's essentials and thus unreadable. Bad.

Code comments #2: A way to explain for non-programmers how the code works. Wrong place.

Code comments #3: Company policy. No one really knows why, but others do that, so we better do it to. The management sucks.

Code comments #4: Because some hip methodology/guru describes how to document code. After a few years, when the methodology has been (unofficially) forgotten, everyone still comments the code the same way. The old management sucked.

Code comments 5#: For insecure programmers who want to convince them self they understand the code they've written. Maybe apply at McDo?

Code comments #6: Some programmers are apparently paid by lines of code. Possibly understandable.

// Comments, anyone?

My internship company does not believe in the concept of 'commenting'. They just tell me: "Ahh just write readable code!
Yeah that's cool until I need to read out thousands of lines of javascript without a single comment!

Really wish the world was less volatile when it comes to opinions!

Commented on a video about fallout 3 being an important game and a tonne of people were bitching and insulting the creator because they think New Vegas is better...

I commented saying I prefer fallout 3 and instantly got bombarded with insults... Ugh

Hope none of my games will ever cause this shit -,-

I’ve noticed that, due to my large commenting sprees, most of my devRant ++ revenue comes from comments. Anyone with a similar situation?

The student assistant gave me a half point penalty for writing down to much comments! Direct translation:
To much of this kind of comments is not needed, the code itself is clear on its own.

Just read this comment in my code from a few months ago... I guess I was in a strange mood at that time..

// Listen for fuckers. Also known by their muggle name: users.

Honest, they are. 😆

When I comment I over comment, and I mean EVERY LINE HAS A FUCKING COMMENT.

Maintaining old code as comments, coz... you never know when that bug in your commented code turns out to be the next big feature.

HOW. IN THE WORLD. COULD IT BE SO DIFFICULT TO COMMENT THE CODE I WRITE MYSELF ?

After my first project (you know, the "Working project I made for fun long ago" code everyone did once, but when you look at it again it looks like sorcery and there's no way to understand it ?), I decided that I'd comment almost everything I'd do... But...

When I begin a project, it's fiiiine and I do my comments the way they should be... AND THEN, WHEN DIFFICULTIES ARRIVES AND I START TO BE TIRED (ie : always) THEY START TO INCLUDE INSULTS OR WEIRD JOKES ABOUT THE PROGRAMMING LANGUAGE, MOVIES REFERENCES, AND SOMETIMES THEIR LANGUAGE VARIES. (Like, that project you're doing in English and suddenly there's a comment written in French in the middle of that)

Soo, yeah, even if I do comment my shit now, it isn't more helpful, lol. Maybe I should listen to relaxing music when I code err.

Oh, comments. Damn comments. Someday I'll do those correctly. Maybe.

Let's try this.

In the project I'm working there is an strict rule : NO COMMENTS!!!

I mean wth, the times I've spend hours trying to understand the crappy legacy code in VB.Net that has been there almost decades, that wouldn't happen with comments, I know i know there are some supernatural developers that think in binary and their eyes work as compilers, but I'm not like that, so seriously go to hell.

P.S. Of course I follow that rule, after all, my code is so damn perfect that even a baby can understand it.

jk

Write comments like Morgan Freeman describes how the software was build.

And I go like I can swear I've never seen this before

If you comment your code like this, I'd like you to rethink your life choices.

This is a project we need to work on in university. The code was given to us.

You know you are fucked, when you find a comment asking "What's happening here?".

#define TRUE FALSE
//Happy debugging suckers

So, Instagram put that "Be the first to comment" as a part of the background on the image itself. Whenever I scroll past comments that is visible in between the gaps. They couldn't even render a simple text view if there are no comments. And, I thought I was the only one who uses lazy hacks to make things work.

While I was still in University I didn't valued much the importance of comments and documentation, mostly because my projects were small and I was working on them​ by myself. Frankly, writing comments felt like a waste of time those days.

Now that I'm a junior developer working with an existing code base and together with other devs I couldn't be more grateful seeing those green lines of human readable strings. Without them I would have struggled more and probably been less productive.

/*
People on here keep using single-line comment for multi-line comments. (Sighs deeply)
*/

When you accidentally commit and push code that has massively commented out sections that you meant to remove >:/

Let's do a poll.
➕➕ only if your language of choice is:

*Writes something I think is clever
*Write like a 3 sentence comment explaining why it's clever.
*Smugly run.
*Doesn't work.
*Quietly erase line and comment.
*Repeat

What's the funniest comment you've ever come across in someone else's code? 🙃

Code never lies,

Comments sometimes do... 🤔

Is it odd that I prefer to not put a space before single-line comments? For example, I prefer
magic(); //Does magic
over
magic(); // Does magic

Last 4 days, struggling to get ship it from a Dev who is reviewing my code.

The comments have already piled up more than the LOC submitted.

The code review consists of just 2 interfaces and a pojo. Hardly 20 LOC in total, excluding javadocs.

I hope it gets ship it soon.
Wish me luck.

I just took over a new project from a brand new client today. It's an Android app that he said needed some updates and refactoring, and he said it wasn't well documented but he would add some comments for me before giving me the code. He gave me access to the code today and one class in it is over 1200 lines long with exactly 4 methods in it... the shortest method is still over 200 lines long. There is one comment at the very top:
// Needs refactored.

... gee thanks.

Has to review another Devs TypeScript project. And what do I find?

A single ts file with 700 lines of uncommented pure hard logic

A client's company will be sold, including the code we've had written for them. But it was the usual we-got-no-time project, so we cut the documentation.
Well, guess who has seven days left to add comments on a ~15k custom-PHP-lines project (RESTful Backend)
After that, some other Dev _might_ be able to understand at least something.
Also, I'm doing huge refactoring, improvements of code-smell and restructuring the whole project.
Maybe, our company stays as a development company for the new client but maybe not. So I'm paying now for being "lazy" two years ago.

Apparently someone decided to use comments on the tracklist of this album.

Ah yeah

That moment during your internship when you work on a project using a framework you're not familiar with, with no doc, and absolutely no comments, and you find a file with 1.3k lines of code without the ability to contact the previous dev

What's your best code comments ?

Here is mine ! Wrote few days back..

Hold on . . :D

Not commenting my code 😨
Oh heavenly one, please allow me to atone for my sin 😭

Currently doing a lab in XQuery. The comment notation always makes me smile :)

Code never lies.
Comments sometimes do.

So Ive to make new screens in xaml in combination with C# (WPF)

So I had something like this in the codebehind
titleBox.Text = Properties.Resources.someKey

The resources looks like
<data name="someKey">
<value>some text</value> <!-- this is some comment --> <!-- and another one -->
</data>

The title got as value "and another one", when I removed it it became "this is some comment" removing that resulted in the value "some text"

!rant

Having lots shitty comments and lots of shitty rants is like having passive income, the ++ come slowly but surely.

"Multiline strings can be used as block comments in Python." Except in some places, where your code will pretty much blow up without any errors, because instead of commenting out a portion of an array, you've just added one big string element. And there's no other way to make block comments. And after actually commenting out every single line, your version control won't know how to merge it anymore, because there are now 100 changed lines instead of 2.

I rarely comment my code.

But when I do... I do it in production.

/* Spending time writing comments in code because if everything else fails, at least I can write a novel depicting a deteriorating struggle to make up my mind from them */

So I did a code review for a colleagues pull request and I've noticed that he hasn't written the PHPDocs for a lot of the classes and functions. One minor thing I wrote is to add the author for the class.

About 2 mins after writing that comment he came over to tell me why should he write the author in the comments when people can just go look at the git commit logs. I was like WTF? I asked why would he do that, his answer was that if there's an issue, we can just use git blame to identify the author. To me that makes no sense as git blame isn't supposed to be used like that.

It's guys like these are the ones who don't document anything whether in an online document or even in code. And they just make work harder for the rest of us.

Me: I'll comment that later
Also me: Why tf isn't there​ any comment

No seriously, comments and documentations are really necessary. Today I've been debugging for hours, why a certain variable has a certain value. Age of code: 15+ years. No comments. No docs. 🙃

I always write this type of values/comments in my code, references to stuff I like. Hopefully some future developer gets them

Download an open source project and look for code comments to get my understanding... Nothing but 'todos' here and 'todos' there

Awful idea of the day - Have a programming language with no comments, but regex preprocessor macros. Use macros to define your own comment syntax and strip them before compiling.

#define /\/\/.*//

Shouldn't JSON have comments too?

COMMENTS BE LIKE...

Physics exam. Seems I was the special guy who did the task in a different (and almost correct way), so my teacher had to share some golden thoughts with me.

Passed anyway xD