A colleague at work forwarded this link on our Dev chat channel and led me to a good session of unproductive hilarity. Code comments, when they are present, are a reflection of the personality of the programmers and it is great to see that as a community, we have quite a good sense of humor. I’ve compiled in the following list the 1o comments I found were the most hilarious or relevant. Of course this is my Top 10 and thus highly subjective:
// 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
/** * For the brave souls who get this far: You are the chosen ones, the valiant knights of programming who toil away, without rest, fixing our most awful code. To you, true saviors, kings of men, I say this: never gonna give you up, never gonna let you down, never gonna run around and desert you. Never gonna make you cry, never gonna say goodbye. Never gonna tell a lie and hurt you. */
Exception up = new Exception("Something is really wrong."); throw up;
// somedev1 - 6/7/02 Adding temporary tracking of Login screen
// somedev2 - 5/22/07 Temporary my ass#define TRUE FALSE //Happy debugging suckers
if (/*you*/ $_GET['action']) { //celebrate
// If this code works, it was written by Paul DiLascia. If not, I don't know who //wrote it.
//When I wrote this, only God and I understood what I was doing
//Now, God only knows// drunk, fix later
// Magic. Do not touch.
Visit the link for more nuggets and context on some the comments listed above. What is the “best” code comment you ever saw?
Worst comment I ever saw:
// Comment goes here.
IMHO the worst are these:
//Setting foo to 7
foo=7;
//Check if bar is true
if(bar){…}
To be fair, #3 isn’t a comment.
No. 7 is awesome!
Nice compilation 😉 Several of them could be from my university assignments (post-drinking hacking was considered cool) 🙂
One of my real-live favorites is:
try {
..
} catch (SomeException e) {
// swallow
/*
* somedev1: what do you mean? african or european swallow?
* use http://style.org/unladenswallow/ for refrerence
*/
}
6. is my favourite – nice PHP line!
Some months ago I found this comment while digging through code:
// They made me do it