Should You Comment Your Code?
simpleprogrammer.com
simpleprogrammer.com
- strict order of execution
- math formulas in the code (or its results)
- external systems requirements/hacks
- non-explicit side effects
- legacy or costly known issues
- intention of cryptic code
- design choices (and its tradeoff)
- ..
This obviously implies you actually care about who will maintain such bestIf you don't, I feel sorry for whoever has to maintain your code.