Abou Kone

10 “Best” Code Comments

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:

  1. // 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
  2. /** * 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. */
  3. Exception up = new Exception("Something is really wrong."); throw up;
  4. // somedev1 - 6/7/02 Adding temporary tracking of Login screen
    // somedev2 - 5/22/07 Temporary my ass
  5. #define TRUE FALSE //Happy debugging suckers
  6. if (/*you*/ $_GET['action']) { //celebrate
  7. // If this code works, it was written by Paul DiLascia. If not, I don't know who //wrote it.
  8. //When I wrote this, only God and I understood what I was doing
    //Now, God only knows
  9. // drunk, fix later
  10. // 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?

By:

Abou Kone

Posted in:

11 responses to “10 “Best” Code Comments”

    • 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
      */
      }

      Reply

  7. […] 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.    News Read the original post on DZone… […]

    Reply

Leave a comment