Re:Don't waste your time commenting source code
by nupark on Monday March 14, 2011 @11:06AM
(#2322744)
I've worked with a lot of legacy code over the years. I don't usually care whether code has comments or not. Comments are a very poor way of expressing semantics in code.
When working with legacy code that is not commented, how do you determine the invariants of an API?
That is, how do you ensure that the change you're making will not break other code? Do you have to scan the entire project, and any other projects that depend on it?
Unit tests are often not sufficient here -- changing the invariants of an API may not result in deterministic failure -- in fact, invariants often describe requirements necessary for deterministic behavior.
When working with legacy code that is not commented, how do you determine the invariants of an API?
That is, how do you ensure that the change you're making will not break other code? Do you have to scan the entire project, and any other projects that depend on it?
Unit tests are often not sufficient here -- changing the invariants of an API may not result in deterministic failure -- in fact, invariants often describe requirements necessary for deterministic behavior.