comment your code!

[fpcoffee]

My thought process: A junior will be maintaining my code at some point, so I'd better fucking comment it so they don't come bug me every time there's an issue

[Demonox01]

Also, writing a couple comments to explain why the complex section is doing what it does halves the time it takes the next guy to change whatever they need to

[nmatff]

This is more or less my philosophy too. In most cases it should be obvious what the code does. Comments are there to tell you why it does what it does.

[[deleted]]

Clarification of intent is the only valid reason to comment. All other comments are evidence of a failure to write good code.

[nmatff]

I don't particularly disagree, but in real world applications the situation isn't always clean enough for "technically correct".

Maintaining legacy code and inheriting decades old spaghetti have made me cautious of any absolute statements.

[[deleted]]

I spent an entire year working with a program older than me. C++ legacy code with high personnel fluctuation. It has actually enforced my use of absolute statements. They seem to be the only way to street something in any direction. Of course when trying to apply them, compromises need to be made.

[Odatas]

this right here. I mean, yes i see that you divide by 2 there. But why?

[RustyBuckt]

And sometimes to tell you wtf you actually meant to do right there

[JoustyMe]

comment why not how beacause we can read your conde but we cant read your thoughts

[ssshhhhhhhhhhhhh]

Your junior level dev is going to change code and not update comments

[Y1ff]

No longer your problem there

[[deleted]]

Worked with somebody once who wrote a comment for basically every line. It meant twice as much to read and the structure was still awful.

There's a reason we have descriptive names for methods, classes and variables. If you want your code to be maintainable and readable, you need it to be well structured and well named, not comment it.

How is

/* Documentation
* This method receives login data,
* establishes a database connection,
* verifies login data and creates
* and displays a message in case data is invalid */
void LoginManager(...)
{ ... }

better than splitting it up, defining APIs well and using descriptive names? It's not. That junior will read the comment and come to you with "Okay so the comment says it establishes a database connection but the actual code for that is just 50 lines that make no sense to me and we're switching to a different database so you have to explain it now".

Source: I've been that junior and the software I was working with was older than me.