If you can't say something nice ...
Posted by: mikes web log,
on 02 Jul 2009 |
View original | Bookmarked: 0 time(s)
At work, we write documentation for programmers, so our docs include many code examples[1]. We should comment our code, right? Of course. However, a discussion broke out in our ranks yesterday about the whole idea of commenting the example code. The discussion arose out of the complaint that a lot of comments in a lot of code (not just ours) are actually lame. This was an observation made in a recent blog entry, which used the following as an example:In the wake of this, a semi-unserious proposal...