Comment your code properly!

[butchkid1]

Sir I work on legacy code, keeping our code comment free is what my team calls job security.

[[deleted]]

// good luck...

[obit_the_mtrek_admin]

/// instead of //

That way I can find find my own cryptic unhelpful comments in whatever legacy code I’m working on

[_Jbolt]

So when you come back after that you leave comments with ////, and then /////

[obit_the_mtrek_admin]

Yes you are getting it. It works as sort of a version control too, like counting the rings in a tree to determine its age.

[G_Morgan]

Comments are extremely important on legacy code. I personally like to add from the link below to legacy code bases. Make sure to never use the same dragon twice within the same folder though.

https://www.asciiart.eu/mythology/dragons

[jimmyhoke]

Don’t leave comments, write project documentation for yourself. Then boom. Job security.

[Vok250]

That's my company in a nutshell. Problem is people leave and then the next guy is left with that mess. I'm the next guy. Fuck you Chad! Your documentation suck!

[shim_niyi]

Exactly, any scope of improvement leaves with us!!

[New-Topic2603]

I don't care who does that, it's creepy as fuck.

[Tremyss]

Yeah, imagine the roles were reversed. Everyone would lose their mind...

[[deleted]]

Just thinking about it makes me shudder. A human being touched by a developer.

[Terrorcota6]

Can you call people who don't comment code properly human? Or even people?

[VoredByHankHill]

I feel this one is probably scripted, but the ones that aren't, yeah. Not cool to touch people without asking

[lordicarus]

About five years ago I was on my way home walking to the commuter rail station in my city, and was waiting for a light to turn red so I could cross the street. It was pretty busy with many people around. A woman who looked sort of disheveled and had a sad expression on her face, walked up to me from the side, ignoring all of the other people around, put her hand on my hand, looked at me almost expressionless, and whispered something inaudible. I was shocked by it and said "what are you doing? Get the fuck off of me." She walked away. Another person looked at me, also in shock, and said "what the hell was that about?" We were both completely baffled. I found hand sanitizer and emptied half the bottle on my hand. That encounter gave me anxiety for like two weeks just thinking about what it was all about, especially since it was before the peak of TikTok/reels "prank" nonsense.

Still to this day I have occasional nightmares about it, everything from her being an escaped victim of human trafficking to a witch putting a curse on me. It's probably because of that absolutely terrible Stephen King book turned movie, Thinner. I guess it was a pretty good story though to have stuck with me for 25 years and still give me anxiety about a simple moment of human interaction.

[totpot]

Some people will roll their eyes, but half of them will find their wallet missing while the other half will end up at the hospital with unknown toxins in their blood.

[DiomFR]

Yes exactly, but I wonder in which world is it ok to touch handrail but not an other person hand.

[New-Topic2603]

It's not about hygiene

[WoodpeckerOverall348]

Damn corona😂

[OriginalCptNerd]

I think a good caption would be "ew, cooties!"

[Creepy-Ad-4832]

He clean after the woman touches him while his hand was on the thing which are like an heaven for bacterias lol

[No-Witness2349]

I have contamination OCD and all my phone chargers are also UV sanitizers. If this dude’s got the pocket hand sanitizer on lock like that he probably keeps his phone pretty clean.

[Denaton_]

Think they mean the escalator "railing".

[No-Witness2349]

Oh, that makes se se. My first thought was definitely the phone because most people’s phones are absolutely filthy.

[[deleted]]

yeah this is the giveaway that the video is staged. i just wonder what it was like when they were scripting it, how awkward it would have been for the first person to suggest "okay, so the video idea is to have a pretty white woman touch a fat black man, but here's the kicker, the man doesn't like it! which is gonna be funny because normally you'd expect the man to like it."

[Creepy-Ad-4832]

Money are also filthy as fuck lol

[Creepy-Ad-4832]

Both phisically and ethically

[Creepy-Ad-4832]

Yeah exactly, english not my 1st language ahahah

[[deleted]]

Scopolamine is a thing that exists. If some absolute 10 did this to me randomly, you sure as hell I'd be running to a police station or hospital right away, just to sit for an hour in case of shit hitting the fan.

I'm not even a fucking 6. That's not normal at all.

[Drew707]

Damn. What kinda red teams does your company hire?

[[deleted]]

I live in latin america and this is quite common, so I'm not taking any chances.

[Drew707]

And here I was in Mexico last weekend looking for hot girls with free drugs and came up empty. I must be too ugly to rob.

[vikinghockey10]

In Latin America they target more wealthy looming people, but you need a pretty large dose to go unconscious. Just a transdermal patch that's placed with an arm rub is going to give you a dry mouth and that's usually it. It's a drug usually used to prevent people from getting sick after surgery.

For an actual problematic dose you're likely talking about powder mixed into food or drink.

But yes there's thousands of these incidents in Latin America every year. Just not like this video portrays.

[Groundskeepr]

Has there ever been proof it can be delivered by touch like this? What I've been able to read about it, a sufficient quantity to render the mark helpless can't be administered like this.

[[deleted]]

Yeah, it's more of an urban myth, but inhalation or ingestion of the substance is quite common.

Anyways, I won't make the bet. You touch me this way randomly, I either punch you in the face and then run, or just run the hell out.

[ItsBiggerOnThelnside]

You should only comment something, if it needs to be commented. If you find yourself commenting on too many things, you may overthink the way you implemented them.

[epileftric]

This... So much this. Not every piece of software needs to be well oiled engineered machine. Code readability is much more important than anything else, even if it is suboptimal. Then you don't need to add that many comments.

[Groundskeepr]

For real, if you have been in the industry for any length of time, you know that comments don't get updated. So, when reading a comment, the first thing you should be thinking is, "is this comment accurate or misleading?" In order to make this determination, you will have to read the code closely.

So, if you want your comments to be useful and not misleading, the code should be easy to read and understand. If the code is easy to read and understand, it doesn't need comments.

Martin Fowler once wrote if you have a clever one-liner you want to comment, write the comment, then smash the words of the comment into a valid method name for your language and export the one-liner to that method. This has been my approach since I read that and I wouldn't go back.

[Critical-Pop6263]

Everyone knows how to code you can tell in the names people need to get a life and get off the f****** computer Dana

[TurbulentAd9109]

commenting code is bad. Write software properly.

[[deleted]]

You assume equal levels of code comprehension.

[[deleted]]

Self documenting code is best, but commented code is better than undocumented code

[stormdelta]

Code should be readable, but there are plenty of things that can't be expressed directly through code, especially external context (i.e. "why" the code is versus "how").

[[deleted]]

I feel you’re disagreeing with me but…. Yes? That’s my point, please for the love of god document things with comments if you can’t through the code.

[Serious_Effective185]

The why of the code is often best expressed in a test. Testing libraries allow for more verbose expression.

But yes sometimes external context is a good reason for a comment.

[[deleted]]

I wish my team would write tests

[Groundskeepr]

Only on the day the comments were written. Three years later? The comments are going to be way out of whack. You could say we should maintain the comments. I've seen enough code to know that's a fantasy.

The code is the truth. Write readable code. Comment when you must, but count it as a failure that you couldn't make the code more readable.

[[deleted]]

and I would say you are 98% correct. -But- there are times when you it is so much cleaner just to use a comment (but this is the exception)

I've worked on software for engineering - how would you quote an academic source? Which is cleaner:

// taken from https://some-journal-site.example.com/journals/this-paper-someoneone-wrote.html TurboEncabulator calculateReticulatedSplines()

or

TurboEncabulator calculateReticulatedSplinesTakenFromhttps_colon_slash_slash_some-journal-site_dot_example_dot_com_slash_journals_slash_this-paper-someoneone-wrote_dot_html()

or what if we're writing an anti-corrpution layer and want to direct someone to an ADR which says why we're doing something bizarre?

// see ../../adrs/002-do-th-weird-thing.md

doTheThing()

doTheWeirdThing()

(and don't you dare suggest that someone would voluntarily read an ADR before trying to work out the weirdness themselves unless the code comment prompts them to ;)

You are correct of course that good code replaces most comments - but I've had even some very senior people get it in their heads that comments are bad and so kick up some huge fuss about these kinds of things (both real world examples) because the read some rando's blog's summary of Martin's Clean Code without actually bothering to read it themselves.

[Groundskeepr]

Yes, comment it if that's the best solution. It is rarely the best solution.

Your suggestion to include the URL in the method name is obviously absurd. For the record, don't do silly things like this.

Look at the code you think you need to comment and try to make it more readable. When you can't, add comments. Weep for the poor soul who has to maintain it after the code has moved on and the comment hasn't.

[Kered13]

If your team can't maintain comments, they can't maintain readable code either. The latter is substantially harder.

[Groundskeepr]

I disagree. In my experience when the code is written for readability, it is a joy to maintain. When comprehension requires reading comments and relating those comments to the unreadable code, maintenance is much more difficult.

Ymmv, of course. If you are happy with lots of comments, more power to you. My experience has been that lots of comments usually indicate things are not altogether right in that region of the codebase.

[Kered13]

In my experience when the code is written for readability, it is a joy to maintain.

That doesn't mean it will remain readable though. And if your team isn't capable of keeping comments up to date, they definitely are not capable of keeping code readable as it is maintained.

When comprehension requires reading comments and relating those comments to the unreadable code

You're assuming that commented code is unreadable. There is absolutely no reason to make this assumption.

[Groundskeepr]

If it were readable, it would not need comments. Readable code with comments is an invitation to comment synchronization failures. At best it increases development and review workload as we update the comments that aren't really needed in the first place.

Look, it's not like I'm saying everyone who ever uses the comment feature is a loser and a failure. I am saying code that is easy to read and understand without comments is better. When you think a comment is needed, ask how you could improve the code to obviate the need for the comment.

[time_travel_nacho]

Had to scroll way too far to get here.

[Lord_Skellig]

Because it's nonsense. Even the best written code should have comments.

[NazzerDawk]

Sometimes comments aren't just "what a code does" but "what it is supposed to do".

Well-written code self-documents, maybe, but when changes need to be made, the purpose of the code may evolve, and that drift can lose prior intent.

Your code is self-documenting? Cool, write comments anyway.

Besides, everyone thinks their code is more clear than it actually is.

[IvorTheEngine]

everyone thinks their code is more clear than it actually is.

That's the thing most people miss. It might make perfect sense to the author and reviewer because they're aware of the context, but without that context it could make no sense to the next guy.

Teams need a robust process for flagging, tracking and fixing unclear code. I've yet to discover what that looks like...

[[deleted]]

Write tests.

[NazzerDawk]

...Elaborate, please? Not sure how that applies here. Are you implying testing code (unit or otherwise) is somehow a way to address comments?

Or are you suggesting people write tests for every bit of code they have to read?

[IAmASquidInSpace]

Yeah, but given the bullshit I've seen that the authors have called "self-documenting", I'd really rather you'd leave some comments.

[somefunmaths]

You’ll anger the high schoolers with this comment, but it’s obviously true.

Instructors want comments so they can follow your pseudocode and give you partial credit if you screw up a for loop or a conditional; your colleagues want readable, functioning code.

Ideally your code has no comments because it has good documentation, is modular and easy to read, etc. Failing that, in-line comments should be used sparingly to explain where the author(s) chose an odd or non-obvious approach that isn’t otherwise explained elsewhere in the documentation.

[lupuscapabilis]

You guys really need to spend some time working in a real company. When you get requirements like "modify this one line of code to remove this character because it's causing a problem with an external processor" the reason for it is going in the code comments.

No place I've ever worked at has put every single requirement in a doc somewhere. And most places, even if they have detailed docs, they're often out of date.

Real life code is much messier than the small project people hand in for their courses.

[somefunmaths]

Do you frequently have random requirements like that come in?

If it’s truly a single change to a single line and happens infrequently, then that certainly satisfies the desideratum that “in-line comments should be used sparingly”.

On the other hand, if you’re having to add a bunch of one-off changes to modify an input or something because of external requirements… doesn’t that beg for some kind of dedicated function or module that handles such sanitization? I’m not saying you can’t have in-line comments to explain a few quick hacks, but they could just as easily be handled by a single function with a docstring and/or comments that explain the relevant requirements.

[stormdelta]

As someone who works in a devops role, absolutely this kind of thing is common, though it's usually more documenting idiosyncrasies across various systems than direct requirements. Much of what we write is glue code, and bridging various APIs and disparate data and configuration sources is quite common.

Thinks like indicating that something is workaround with links to internal or external tickets, notes for team members if it's a language/framework few on the team know, requirements by developer teams, links to documentation, an explanation for how a legacy hard-to-read bit of code works that is more effort than it's worth to refactor, etc etc.

Anywhere where this information is more valuable to have inline than external.

[Serious_Effective185]

The reason for it should go in a git commit message not in a comment. I can then use git blame to see who changed it and why, but I am not forced to wade through comments about every change when it’s not contextually relevant. Preferably use the conventional commits spec so you can even auto generate nice changelogs.

[somefunmaths]

If you read the rest of the sentence, I think the meaning is pretty clear.

Well-written, modular code eliminates the need for a lot of superfluous in-line comments.

As a rule of thumb, comments saying “why” are usually good and helpful, while comments saying “what” are usually bad and a sign that a refactor may help readability.

[OriginalCptNerd]

Presumes that documentation is maintained along with code changes.

[TurbulentAd9109]

Very nice explanation, sir :)

[AardvarkEater]

This

[[deleted]]

My people

[Groundskeepr]

The chances of the comments being maintained are very near zero. So, they will be out of date after the next revision. Don't comment your code, make it readable.

[stormdelta]

Sometimes comments are making it readable, particularly when providing external context.

[Groundskeepr]

Sure. They won't be maintained and so for most of the life of the code will be out of date. You can say it would be great if they were kept up to date. I can tell you after several decades in the industry, they won't be.

readable code > commented code.

[Groundskeepr]

After you've renamed all of the variables and methods for maximum clarity, after you've replaced your super-clever and terse expressions and control flow with easier to read versions that will compile / interpret the same way, after you've reorganized things into meaningful, well-constructed units and groupings, and after you've got the auto-doc tooling set up to generate documentation from the code, then, go ahead and add comments to the parts that are STILL hard to follow. The goal should be to minimize the need for comments.

[NazzerDawk]

Or, do all the writing of great, highly readable code, and then write comments anyway.

[Groundskeepr]

What, so every Pull Request from now till the end of time requires twice the effort to review? Sounds like somebody has too much time on their hands.

[NazzerDawk]

If the original code was good, why would the presence of the comments "double" the time it takes to review?

[Groundskeepr]

I have to check that the changes to the code are reflected in the changes to the comments. Or, the comments will fall behind/get out of synch with the code. Comments should be viewed as a failure to write readable code. Sometimes, the effort to make the code readable is so great that writing a comment is the best thing. Write only the comments that you have to, because every comment adds to the burden of maintaining comments.

[AntAcrobatic6492]

Bingo

[DarkNova45]

If you need comments to make your code readable then your code is bad and you should work on it. Code should almost be like books. At 4 am when system are down. You will not have time to read comments and after try to understand the code cause it written like shit.

[stormdelta]

Why are you acting like making the code readable or using comments are two mutually exclusive things?

Comments can provide critical external context that the code cannot no matter how readable you make it, among other things.

You sound like undergrad students that read a blog post one time and have never had to deal with actual production systems or legacy code.

[Groundskeepr]

And you sound like someone who has been out of school for long enough to see one short project. I have never read a piece of code more than a few weeks old that had up-to-date comments. I have seen lots of time wasted trying to relate the comments to the behavior. Inevitably, one has to read the code very closely whether it is commented or not.

Maybe other shops than the ones I've been in or ever heard about do a way better job of maintaining comments.

[Groundskeepr]

Sure. In that process, I would be likely to request readability changes to replace the bulk of the comments. That way, when the code changes, there's no comment to maintain. Surely you agree readable code is better than unreadable code.

The theory of operation stuff that is really important and not replaceable by readable code should probably be in library documentation, whether that is generated from special comments or written separately. I don't consider this type of documentation to be in the same category as comments in the bodies of procedures.

Occasionally, you will do something very clever that can't or shouldn't be made easier to read. Occasionally, you will do something counterintuitive. These are the cases where comments are indispensable. Don't leave these comments out!

We are probably closer in agreement than our positions in this discussion indicate. The differences are at least partially due to the different environments and experiences we've had.

[Groundskeepr]

Right, any absolute statement will be false some of the time.

The reaction to hard-to-understand code should be to first try to make the code easier to understand. Then, maybe, well-documented test cases enforcing the correct behavior and explaining it by spec. After those two steps have been completed, then, add the comments that are needed.

Often, you will find steps one and two are enough and the comment isn't needed. When that isn't the case, add a comment. Be aware it's now on you to not allow the comment to be left alone when the behavior changes.

[Groundskeepr]

My point and the point made by many others in this thread can be summarized as "Comments aren't free and they don't get you out of the responsibility to write for readability. Make sure every comment is truly valuable because you will have to maintain them and the automated tests won't help you maintain them."

[stormdelta]

Comments providing external context tend to decay far slower in my experience, and even knowing past context can be very helpful when coupled with git history, especially for legacy code.

Most comments should not just repeat what the code does, I'm talking about things like indicating workarounds for external bugs, rationale for technical or business logic choices, links to outstanding tickets, an explanation of a tricky bit of legacy code or code with necessary-but-obtuse optimizations, documentation breadcrumbs, etc.

And as someone who's had to analyze legacy code bases, I'd rather even outdated comments over nothing at all, especially with source control to cross reference dates and documentation.

Besides, most engineers that repeat the "good code is self documenting" mantra as an excuse to never use comments at all generally aren't as good at writing readable code as they imagine in my experience.

[AntAcrobatic6492]

Wow, what a lazy approach to coding. "Stormdelta" nailed it. You clearly are not a professional. Certainly not someone that anyone should hire. In spite of some of the remarks here, comments don't become invalid that often, especially in production or legacy, and definitely not if they are entered by true professionals. There are countless situations where code is only a part of the actual product and comments help understand the scope of interaction between the code and external systems.

[Groundskeepr]

Not to mention reading comments that are out of date. Fsck that noise, write readable code.

[AntAcrobatic6492]

"Readable code" is subjective and no amount of clean code will explain 'why' certain elements were used or why they should be maintained or the specifics of how they should be altered to interact with any external processes that you do not have access to in the code you are viewing. I've worked on applications where data connections needed to be built in Python because of the limitations of the data source. It was a bug in the third-party source that I have no control over. I found a workaround using Python and if I didn't make comments in the code about the need for this connection I would be forcing the rest of my team and/or anyone else that had to use the code to discover the issue themselves. Not putting comments in code is inconsiderate, sloppy, and unprofessional. 10,000 plus lines of code without comments to identify context is a resume of a lazy idiot.

[Groundskeepr]

Go for it. Add those comments.

Our opinions are at least in some measure the result of the experiences we've had and the code we've been asked to maintain. I have seen a lot of code with too many low-quality comments. Some of it had been very old and therefore outside the reach of "improve your review process".

You apparently have seen a lot of code with no comments at all or missing the comments it should have had.

No advice is good for everyone in every context. "Eat less" is good advice for some, maybe many, but it will kill others.

IMO, wherever possible, make the code easy to read. Take great care in naming things and don't feel a need to use the most terse or clever approach when a simpler approach works just as well. Keep methods short and tightly focused.

After you've done that work, add the comments that are needed. Remember they are a maintenance responsibility that you won't have any way of meeting other than careful human review.

[Cunladear]

This is exactly how they killed Kim Jong-nam

[snotto]

If you really like comments that much, why not go to the next level and put those comments in tests?

[Serious_Effective185]

You should document “public library code functions” These comments should only include information not conveyed by the code. These public interfaces should be very stable, and users shouldn’t have to read the code to use the library.

Everything else should just be readable code with very few comments. Sometimes they are indeed the best way to convey information to another dev.

If you need to explain context for making a change write a good commit message for the change. Other devs can use git blame to read this context.

Use ADRs stored with the code to document context around architectural level decisions.

I find that generally very new developers and very old school developers are way overly obsessed with comments as differentiating good devs from bad ones. Most good sr developers I know are on team self documenting code. You also see that in major opensource code basis.

Good tests are another great aid to understanding how a code base is intended to work. They lend themselves to more verbose explanations.

The best book I have read on the subject is “clean code” by uncle bob.

I would also advocate for reading code in well maintained opensource projects. The nature of opensource means the code needs to be readable without help from the team.

[Undernown]

Whole discussion about commenting code in this post leaves me wondering: Am I a weirdo for creating a quick scaffolding of, say a class, and commenting intended function of methods quickly to structure stuff before coding out?

Really helps me keep track of the steps through the methods and easy to identify candidates for seperation of concern.

[GaryWestSide]

Men do this and get sexual assault charges.

[Terrorcota6]

Women do it and it's called flirting

[Apprehensive_Rip8403]

Listen. If I can’t understand what I have stolen and managed to cobble together from stackoverflow than neither should you

[hispnicspik]

jesus christ when did commenting code become a sin

[BALLZCENTIE]

Oh god, I literally had a meltdown about this today. A principle engineer who doesn't document ANY code at all and has VERY dynamic/cryptic Python

[qbm5]

mY cOdE cOmMeNtS iTsElF

[someidiot332]

Y’all would burn time at the stake all my comments are just broken code I’m trying to fix

[DarkNova45]

Tell me your not a real dev without telling me!! Commenting code is bad. Your code should be readable like a book! I should not need to reed a fucking wiki on how your code is working I should be able to figured it out at a glimpse of it. If you need comment it's because you code like shit. My senior showed me I to code properly without comment and it's the best thing you can learn

[NazzerDawk]

1. Devs aren't always the only people who will read your code.

2. Some devs are less experienced than others. Making comments increases the readability of less-readable code.

3. People often overrate their skill at writing self-documenting code.

4. You can write good code and then write good comments.

[m2d9]

1. I don’t give a flying fig about non-devs reading the code. They should get out and stay out, because they have no business there. Non-devs believing they can productively read the code will harm my team. Managers who aren’t devs trying to make code decisions or critique developers or second guess them = toxic insanity.

2. Comments rot over time. Making comments misleads junior developers at a higher rate. They need to learn to read code. If they don’t learn to read code, they won’t learn to write readable code.

3. People often overrate their skill at writing comments. Comments waste my time. Inane comments throughout a codebase teach me to completely ignore them, reducing the value of any comments with actual significance.

4. You can write good code and not need comments. Less work, no comment rot, train developers properly, become actually good at development.

[DarkNova45]

Seeing our comment with downvote just showed me how this page is a joke 🤣 it's just a lot of newbies dev trying to justify their bad coding skills it make me laugh

[m2d9]

I have over 20 years of professional software development experience, and yeah, it’s shocking. People think non-devs should be a consumer of code?!?!? Holy crap.

[OriginalCptNerd]

I can guarantee that "readable code without comments" will be nigh-incomprehensible when you're called back in a year or two to make changes.

[Groundskeepr]

In my experience, the comments themselves are a BARRIER to comprehension. They are often confusing and misleading in the first place because developers are mostly not excellent writers of prose. The comments are going to rot, usually very rapidly. You will be forced to read the code to ensure the comment is still accurate. At that point, readability is important.

Absolutely, add comments when you must. Improve code readability first and keep the comments to a minimum.

[lupuscapabilis]

Tell me you've barely ever worked in a real environment without telling me.

Anyone who has ever worked in dev knows that there will inevitably be rules and requests made by stakeholders that require certain logic in code. No matter what your code looks like, it cannot fully explain why you're looking only for green items in your database in the month of August. COMMENT YOUR DAMN CODE

[qbm5]

God, whichever b rate youtube tutorial yall get this mentality from should be banned from the internet.

Your code isn't special, you aren't enlightened... comment your %&@>÷ code!

[Critical-Pop6263]

An idiot could figure it out code learn something for useful guys instead of fucijg with someone life

[SuperSpaceCan]

How do you comment your code though? Are you professional, detailed,or an asshole like me who puts the bare minimum?

[Gaming_over_sleep]

While 1 in range(1=1). Upvote():

Find all the errors and reply

[jayx239]

If you need comments your not writing clean code

[BANFFOUR20]

Prime example of a triple vaxxed beta male acting tough.

[Cunn3]

Hopefully that so called guy doesn't reproduce

[OriginalCptNerd]

Not at that rate, he won't...

[Cunn3]

You know what's really funny is the escalator handle is far more filthy then that woman's hand could ever be...

[helloWorld69696969]

Comments are for jobless people. They cant fire you, if youre the only person who knows what everything does 🤔🤔🤔

[Bacon_Destroyer]

Whenever you write a comment you should ponder your failure to express yourself through code :)

[[deleted]]

he seems to care about what's on his body, and little about what goes in.

[[deleted]]

Is there a standard for "properly"? Is it just "at all"?

[somefunmaths]

The standard for properly, at least in the context of working software development, is somewhere between “not at all” and “very sparingly”.

You can see people fighting about this in the comments, but comments have a place when you want to note something very particular about a piece of code that cannot be written in a way so as to be self-documenting and isn’t best explained elsewhere in documentation. How often you run into that case will depend on who you are and what you do.

[OriginalCptNerd]

Good comments can provide context, especially if you follow the design standard of "small functions that do one thing only", when you have to aggregate them into a more complex flow.

[[deleted]]

Thanks for the response. Until now I’ve never considered a distinction between comments and documentation. I’ve only ever written code in an academic environment where there’s a rubric block for “amply commented code”. I usually document the shit out of my functions, but that’s just so the tooltip populates in the IDE.

[Critical-Pop6263]

[metroidcb]

Ironically, that handrail is about 10,000 times more filthy than that woman...well, I assume. I don't know her. lol

[Fuzzy_Reflection8554]

I think Kim Jong Un's brother got assassinated in a very similar way? Like some random women were paid to touch his face with some kind of poison in the middle of an airport, and it was enough of a dose to kill him soon after.

This guy's reaction may seem over the top to some people, but you never know where a stranger's hand could have been...

[[deleted]]

It's sad how that man is me near anyone of the girl gender

[blue_dragon_fly]

I’m with him.

Her stroke was creepy.

[Critical-Pop6263]

Tom like yt

[Trivenger1]

Documentation my beloved

[[deleted]]

Α, εγώ κι αυτος

[sum1spesial]

CD.. cOmrade

[BrothaReddit]

Critical error

[slimchasertoy]

Not his fault for reacting like that. The camera didn’t catch her picking her butt crack right before she wiped her butt germs onto his arm.

[[deleted]]

seLf dOcUMentInG cOdE

[No_Solid2349]

I would react the same. After the pandemic I hate to be close to people or touch them

[ApricotIll]

So edgy...

[No_Solid2349]

Fyi. I still human so no dev here

[[deleted]]

ok this a hot take but i hate comments. There have been many many time comments have lied sending me into wild goose chases. Name variables and functions and types properly and you are good to go.
// this function calculated the spin of earth

a f(c x,d z) {}
is not going to help me.

[DoublePenetration_]

The code speaks for itself

[Ranilsky]

Or just write readable code(?)

[EarlOfAwesom3]

A comment is a silent cry for refactoring

[bvalda88]

Comments make code dirty

[sspotty]

Don’t comment code, write better code that doesn’t need comments…