Comment by dspillett

Comment by dspillett 11 hours ago

1 reply

That only works if the code is good enough to be the documentation. In DayJob prefer to cover all the bases:

∞ Try make the code sensible & readable so it can be the documentation.

∞ Comment well anyway, just in case it isn't as obvious to the reader (which might be me in a few months time) as it is to me when making the change. Excess comments can always be removed later (and, unless some idiot rewrites history, can potentially be referred to after removal if you have a “why t f” moment), comments you never write can't be found later.

∞ Either a directly meaningful commit message, or at very least ticket references to where more details can be found.

For personal tinkering, I'm a lot less fastidious.

rkomorn 11 hours ago

> That only works if the code is good enough to be the documentation.

It never actually is at any non-minimal scale (and not even the code authored by the the people who claim code is self documenting).

My comment was rhetorical and sarcastic.