3 ms·
> software evolution is constrained by organizational stability and the ability of developers to understand the system Simple is better than magic and code doc
by Xeoncross 3y ago
> software evolution is constrained by organizational stability and the ability of developers to understand the system
Simple is better than magic and code documentation is required.
Side note: "loop over items and save each" isn't a useful comment right before a for loop. That isn't what I'm talking about. However, "We have to call this API one-at-a-time synchronously because otherwise their internal WAF will block us if we issue parallel requests" is very helpful context when the obvious improvement to the code is multiple threads/async I/O.
- xnx 3y agoExactly: Comment the "why" more than the "what/how" (although I sometimes comment the what/how if it makes things easier to understand, even at the risk of the comment getting out of sync with the code)