

Indeed. Don’t comment “what”, only comment “why”. If you’ve written code that looks like a mistake but is there for a reason - poor algorithm, not idiomatic, etc. - then the proper “comment” is a unit test that exercises the business logic behind it, but a one-liner to stop someone from “fixing” it is maybe polite too. Don’t write an essay for private functions; rename them so they’re obvious.

















Which messed-up Scrabble board has two Z’s in it so that you can spell ‘quizzed’ or ‘jazzily’? You don’t get the points if you use a blank…