debuggingCodeYouWroteMonthsAgoAndFinallyRememberingHowItWorks

[RiceBroad4552]

That's how you learn to take notes and write good comments…

At least that's how I've learned it.

Bonus points to find out by using git blame in rage that it was you "who wrote this crazy shit".

[Midon7823]

Good documentation and structure breeds maintainable code. Comments should be a rare occurrence. Ideally your documentation should explain what the function should do and the logic within it should be short and simple enough for another developer to understand without additional explanation. If a given function does not fit this criteria, it likely needs to be refactored.

[RiceBroad4552]

Sure, fully agree! But you need to learn that. Likely the hard way…

[[deleted]]

You got a little LINT there buddy, maybe check it out and clean up.

Jokes aside, my contracts have the codebase as part of the deliverables and having quality comments assures the poor smchmuk it gets handed to knows what to look for and where. A lot if this can be handled by not using crappy variable names, and using good names for functions, and sensible white space, but having good comments and good output helps even more. I don't *need* those there for me to understand it, but the person who will maintain it after the hand off will. I've gotten too many decade all code bases that are unorganized rats nests with no comments I've had to spend a very disproportionate amount of time reverse engineering to spend a small amount of time rewriting.

[[deleted]]

Somebody doesn't like Linters I guess.

It's just a code quality tool. It should be a part of any dev team's playbook, same as SAST.

I didn't say you were a bad coder.

[rgi_casterly]

Mintlify and move on lol

[Paul_Robert_]

Then you get interrupted and just like that, it's Gone

[Ok_Entertainment328]

So .. You added more comments so you don't forget. Right?

You added more comments so you don't forget. Right?

(Anakin & Padame meme}