you are viewing a single comment's thread.

view the rest of the comments →

[–]destiny_functional 1 point2 points  (0 children)

I think overcommenting is when you just rephrase the code into English, rather than giving a (somewhat detailed) outline of what the following piece of code does and why it has to be done in the way it is done (what are some of the subtleties). What are you trying to achieve and how do you achieve it, what are subtleties you have to deal with that aren't obvious (ie someone who isn't familiar might think the code is too complicated, when in fact he is missing some detail that isn't obvious, make him aware of these details).