2 ms·
How about a one line comment that summarizes what the block of code directly below does, in order to avoid the need to run an interpreter in your head while ski
by mikem170 4y ago
How about a one line comment that summarizes what the block of code directly below does, in order to avoid the need to run an interpreter in your head while skimming code to find what you are interested in.
That little bit of extra information, which only takes a few seconds to type, can save a lot of people a lot of time afterwards.
I do this, and add any addition "why" or other needed detail indented under the first summary commented line.
- marcosdumay 4y agoYou mean when the code is too long, and you summarize regions of it for easy location? Making the comment large is good enough for that. But a really different tag may help here.