E.g. comments about "what" will be repetitive, out-of-date, etc.
But comments about "why" we're doing something a particular way, especially if it's odd, are great sign posts to future maintainers.
E.g. comments about "what" will be repetitive, out-of-date, etc.
But comments about "why" we're doing something a particular way, especially if it's odd, are great sign posts to future maintainers.