Return Styles: Pseud0ch, Terminal, Valhalla, NES, Geocities, Blue Moon. Entire thread

Commenting

Name: Anonymous 2010-03-29 15:07

Tricky code should not be commented but rewritten

In general, the use of comments should be minimized by making the code self-documenting by appropriate name choices and an explicit logical structure.

Name: Anonymous 2010-03-29 15:27

I write "assume the reader is an idiot" comments.  Comments before functions or methods explain how they do what they do, with formatted ASCII graphics if need be, and inline comments are limited to explaining what task the following portion of code performs.
If something really breaks into "wait, what did he just do?!" I also highlight that specifically.

Newer Posts
Don't change these.
Name: Email:
Entire Thread Thread List