Hacker News new | past | comments | ask | show | jobs | submit login

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.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: