I just recently have come across a hit parade of the most annoying things for the programmer on the internet.

Here they are:

10. Comments that explain “how” but do not explain “why”


In the university where I was a student studying a course of programming, we were taught to make detailed comments to the code. It’s better to have too many comments than to have too few. Unfortunately, sometimes this advice grows into the paranoia, namely programmer comments every single line of code. For example:

$r = $n / 2; // Set $r to $n divided by 2

// Loop while $r - ($n/$r) is greater than $t
while ( abs( $r - ($n/$r) ) > $t ) {
$r = 0.5 * ( $r + ($n/$r) ); // Set $r to half of $r + ($n/$r)
}
+2
Skull 15 february 2012, 19:47