20/10/2023
How is code commenting for you? π©βπ» π¨βπ»
Is it something you grew used to? Or is it something you dread and do only when absolutely necessary?
Let us know in the comments below!
We see comments as clarifications. They're important for the future developers who will read that code. Anything that the code doesn't say by itself, we like to write down.
Also, we like short summaries of methods. That way, we can determine a method's purpose without reading a looong block of code.
Furthermore, we know it's good practice to explain system designs and business flows in external documentation. This leaves the code comments with the single purpose of explaining how the code methods and classes should be used. And external documentation is preferably read before changing code in the system.