Eloquent code needs no comment(alexis.bernard.io) |
Eloquent code needs no comment(alexis.bernard.io) |
Don't tell me what the code is doing, tell me what you're trying to achieve. The goal you're trying to achieve. Tell me the problem and the outcome you want. Then I should read the code with a target understanding in mind rather than starting from nothing.
My mental model of how things work might be different to yours and you need to transfer that mental model to me so I can understand your code.
Context is everything when reading a line of code. Context of the business, context of state of the program, context of variables. Context of microservice state. Context context context.