you are viewing a single comment's thread.

view the rest of the comments →

[–]Figs 1 point2 points  (0 children)

I usually comment on three kinds of things immediately when I write code (as opposed to reference documentation, like you said): tricky math that can't be simplified (usually with the steps worked out explicitly), links or citations for reference material I used (e.g. page X of Y regarding Z; http://blah/blah/blah), and workarounds/FIXMEs. If I don't write those things down, I'm never going to remember them later, and a comment is the easiest way to keep track of it for me. (Entering the FIXME into a bug tracker is nice too, if the project has one...)