3 ms·
I'm always amazed how few developers _read_ documentation of the code if it's there. I've had multiple instances where I comment a section of code explaining w
by kscaldef 16y ago
I'm always amazed how few developers _read_ documentation of the code if it's there. I've had multiple instances where I comment a section of code explaining why it's very important that a certain thing be done just this way (or that a certain thing _not_ be done), only to have someone else come through a couple months later and break things by making exactly the change that the comment said not to do.
- jshen 16y agodid you have a test for it?
- kscaldef 16y agoIn some cases, yes. More frequently this sort of thing has been performance issues (comment reading something like "don't do X here, or else it interacts with Y in a way that kills performance of the whole application"). Testing for performance regressions can catch stuff like this, but since that's not typically done for every commit, you can end up having to do significant forensics or trawl through hundreds of commits to find the cause.