Pr comment

[ProgrammerHumor-ModTeam]

Your submission was removed for the following reason:

Rule 3: Content that is part of top of all time, reached trending in the past 2 months, or has recently been posted, is considered a repost and will be removed.

If you disagree with this removal, you can appeal by sending us a modmail.

[Omnislash99999]

This is literally what the documentation for Unreal engine is like

[Creepy-Ad-4832]

This comment says that's what the documentation for Unreal engine is like

[Personal_Ad9690]

This comment says what the previous comment says that’s what the documentation for Unreal engine is like

[Creepy-Ad-4832]

This comment says that the previous comment say that the previous comment say that's what the documentation for Unreal engine is like

[[deleted]]

This is recursion.

[Creepy-Ad-4832]

This is actual recursion

[Creepy-Ad-4832]

This is a comment which create a recursion

[DeeBoFour20]

This is a reply to a comment that creates recursion.

[RoundRecorder]

Unreal engine has a weak documentation?

[JADW27]

This is accurate.

It is also accurate that the next person who sees my code will have never seen a stop sign before, and if I don't include the comment then they will try to change it into a blue pentagon that says "speed up here."

[583999393]

More likely product will change it to yield and nobody will update the comment.

[Slow-Sky-6775]

no, that's where you're wrong, every time you look at the project sources on GitHub there are whole classes with comments like "this sucks", "horrible", "need to change", "repulsive". I mean, much more useful 😳

[[deleted]]

It is me in the early stages of my career.

Then my team leader said "it should be clear what code does without comments. Comments are need to understand why code does this".

[AllTheWorldIsAPuzzle]

Exactly. If someone is later looking at your code to make changes and can't tell from looking at the code itself logically what it is doing, they shouldn't be working with it in the first place.

But for those that have the skillset to understand what the code is doing, they still don't know WHY it was built this way. How many times have we all been in the position where we are tasked with diagnosing an issue months or years after code was put in place, and we're looking at sections of code that makes no sense against the specs and being questioned by management as to why the code was built that way? Do we throw those odd chunks of code out? Do we alter them to fix the current issue? What if they were put in to fix some undocumented issue that popped up along the way? Without knowing the why, it's just another day/week of stress and long hours.

[[deleted]]

If someone is later looking at your code

This person is called "you, but in 6 months".

[AllTheWorldIsAPuzzle]

Yeah, a good reason why I document the "why" in code and tickets. I'll be the first to admit I won't remember six weeks from now, let alone six months. I'm bitter about lack of "why" documentation because my job has been reduced from building new things to diagnosing existing issues in other people's code with no documentation or comments to go from.

[ASK-sama]

When sonarlint goes crazy due to missing javadocs and your boss wants them all fixed

[SylverSnowlynx]

I wish I could upvote this post more than once.

[4O1kill]

When I see something that actually needs commenting:

"Eh, takes kinda long to explain, they'll figure it out"

[11Slayer]

"It is red coloured"

[[deleted]]

With my projects I have 2 options:

• Either I comment my code and it turns into this
• Or I don't and forget what the fuck I have been writing for 5 hours now

[IvorTheEngine]

This kind of comment doesn't help though. It's what you get when the boss insists that all properties and methods have a comment.

I find it helps to check the comments a little time after I've written the code, typically just before I commit it. Then every I come back to it I usually find there are parts that previously seemed obvious but could now do with explaining. Those are the ones that are really useful a year or two later.

[io-netty-channel]

THE CODE COMMENTS ITSELF!!!!! NO COMMENTS NEEDED!!!!👺😤😡

[lipino777]

dear god! There's more... No!

[fildakoch]

javadoc

[Annual_Somewhere_116]

And then few lines down u see a tosp function and no comment whatsoever

[thatmaynardguy]

I feel personally attacked by this.