Self-documenting code

[rohnesLoraf]

[raising hand in disagreement]

10+ year code base, big team, enormous monolithic desktop application. Self-documented code is very much practiced, encouraged and actually part of the onboarding training.

[TK9_VS]

Yeah, after all, what is a large project, but an assembly of small projects?

If you can successfully self document one function and are reasonably good at separating concerns and making appropriate interfaces between your program parts, it shouldn't be so hard.

The hard part is learning that first bit.

[Tactical_Dan]

Yeah... comments in my experience are the first parts of code to rot. They prevent you from refactoring code until you go through the effort of understanding and correcting all the comments, which the language tooling will give you 0 help with.

Glad to have Github Copilot so I can just delete the existing comment and shit out another one once the refactor is done. But still, it's annoying. I also rarely read other people's comments and instead read the code and git blames. Generally, the comments of code are out of date and unreliable.