Coding. style

[FreddyFreddy]

someone has to do the work of changing stuff which may not always be trivial.

Well I am enjoying doing some work, maybe making a tiny difference. Fantastic way to learn!

[doia]

Code style and formatting matters! When you're not a rocket scientist at least. Time and again I see "Code is read much more often than it is written"

And that‘s why EVERY! function or method MUST have a short description of What and Why it does something, even the trivial ones. „The code is the documentation“ requires too much mental overhead.

[FreddyFreddy]

And that‘s why EVERY! function or method MUST have a short description of What and Why it does something, even the trivial ones. „The code is the documentation“ requires too much mental overhead.

I 'somewhat' disagree. As Bjarne Stroustrup famously said "Express ideas directly in code". If the code uses natural wording to express meaning, then why do we need comments to further explain, or, Heaven forbid 'documentation' to restate the same thing without adding any understanding. The example I quoted could, I believe, have been better expressed which would have negated any firther documentation requirement. Just my 2c.