@[email protected] to Programmer [email protected]English • 1 year agoManager: This task only takes 30 minutes. Why did it take you the whole day?programming.devimagemessage-square98fedilinkarrow-up1791arrow-down18
arrow-up1783arrow-down1imageManager: This task only takes 30 minutes. Why did it take you the whole day?programming.dev@[email protected] to Programmer [email protected]English • 1 year agomessage-square98fedilink
minus-square@[email protected]linkfedilink8•edit-21 year agoP1000x this. I can read a diff. I need to know why. No, a code comment isn’t good enough, it’s out of date after the next commit.
minus-squareDontTakeMySkylink1•1 year agoCode comments for "why"s that persist. Commits for why’s that are temporary. If you need to run X before Y, add a comment. If you added X before why because it was easier, leave it in a commit
minus-square@[email protected]linkfedilink2•1 year ago If you need to run X before Y… Add a test that asserts that.
minus-squareDontTakeMySkylink2•1 year agoWith a comment on the test detailing why it matters so people don’t just assume the test is out of date when it fails. And ideally test the underlying result of x before y, not the fact that x is called before y. And while we’re at it, assert in Y that X has been called, and again comment the reason for the preconditions.
P1000x this.
I can read a diff.
I need to know why.
No, a code comment isn’t good enough, it’s out of date after the next commit.
Code comments for "why"s that persist. Commits for why’s that are temporary.
If you need to run X before Y, add a comment. If you added X before why because it was easier, leave it in a commit
Add a test that asserts that.
With a comment on the test detailing why it matters so people don’t just assume the test is out of date when it fails.
And ideally test the underlying result of x before y, not the fact that x is called before y.
And while we’re at it, assert in Y that X has been called, and again comment the reason for the preconditions.