3 ms·
When I find code I don't understand the purpose of in code reviews I ask the author to document the purpose in the code so that the next person (likely future t
by bvirb 5y ago
When I find code I don't understand the purpose of in code reviews I ask the author to document the purpose in the code so that the next person (likely future them) won't be confused by it like I was.
I find they often end up changing or removing it.
I have a feeling that writing explanatory code comments (as in _why_ something exists) about non-conventional code might come naturally when you've really thought something through. Where vice-versa undocumented non-conventional code might be a sign that they just got something working without really thinking about how it _should_ work.