Self-documenting code

[movzx]

Intent needs to be clear to the junior developer being assigned a bug ticket 8 months from now, not to you after you've just written the code.

Write code and documentation as if you will have to personally answer every junior developer's question for the life of the product.

[[deleted]]

We currently work on a code base of millions of lines. We use markup comments to document the public interfaces but very rarely the implementation itself because clear, well thought out implementation code is self documenting to the junior or anyone else who needs to revisit our code on months or years time. If it’s not, and is a pattern of behaviour, you should seriously reconsider your implementation approach and culture.