← Back to context

Comment by macintux

3 months ago

I regularly have this discussion when it comes to comments.

The intention of the code is much more resilient than the details, so comments should generally focus on the why.

(It’s also important to document the code that isn’t there: algorithms that were rejected due to performance, “obvious” enhancements that don’t actually achieve the intended effect, etc.)