4 ms·
Enabling skim-reading seems a decent goal. As in, write comments such that someone can quickly get a high-to-mid-level understanding of what's happening in a g
by frou_dh 13y ago
Enabling skim-reading seems a decent goal.
As in, write comments such that someone can quickly get a high-to-mid-level understanding of what's happening in a given unit of code[0], with the unabridged version being the code itself.
0: The smallest unit worth commenting being a logical group of lines within a function, usually padded with newlines above and below.