posted 14 years ago
Just an observation--it's not necessarily helpful to over-comment: it's another point of failure, and one that isn't capture-able by tests or compilers. Keeping comments "in-sync" with code is a *lot* of work--eliminate the need to do so whenever possible. For example:Here you basically wrote the code twice, just in a different order, and one time (the comment) is completely unverifiable except by reading it and its accompanying code. That's not helpful, that's just noise, and if it *does* get out-of-sync with the code, it's dangerously misleading noise. It'd be cleaner, and easier, to just write