Sunday, March 13, 2011

Riyad's Technical Blog: Don't Waste Your Time Commenting Source Code

Riyad's Technical Blog: Don't Waste Your Time Commenting Source Code: "Sometimes you just need to leave a note..."

How many of you wish you had run into a comments block like this one:

//
// Dear maintainer:
//
// Once you are done trying to 'optimize' this routine,
// and have realized what a terrible mistake that was,
// please increment the following counter as a warning
// to the next guy:
//
// total_hours_wasted_here = 39
//