3 ms·
I use a similar commenting style, but in addition to the description, arguments and returns, I also list globals used (if any) and side effects (even if none).
by qjz 16y ago
I use a similar commenting style, but in addition to the description, arguments and returns, I also list globals used (if any) and side effects (even if none). I find it very helpful to show if a function depends on or alters state.