Best comment ever

You can find more at http://stackoverflow.com/questions/184618/what-is-the-best-comment-in-source-code-you-have-ever-encountered

LOL :) golden

/*

      .o.       ooooooooo.   ooooo      ooo   .oooooo.   ooooo        oooooooooo.   o8o  .oooooo..o      oooooooooooo       .o.       ooooo     ooo ooooo        ooooooooooooo 
     .888.      `888   `Y88. `888b.     `8'  d8P'  `Y8b  `888'        `888'   `Y8b  `YP d8P'    `Y8      `888'     `8      .888.      `888'     `8' `888'        8'   888   `8 
    .8"888.      888   .d88'  8 `88b.    8  888      888  888          888      888  '  Y88bo.            888             .8"888.      888       8   888              888      
   .8' `888.     888ooo88P'   8   `88b.  8  888      888  888          888      888      `"Y8888o.        888oooo8       .8' `888.     888       8   888              888      
  .88ooo8888.    888`88b.     8     `88b.8  888      888  888          888      888          `"Y88b       888    "      .88ooo8888.    888       8   888              888      
 .8'     `888.   888  `88b.   8       `888  `88b    d88'  888       o  888     d88'     oo     .d8P       888          .8'     `888.   `88.    .8'   888       o      888      
o88o     o8888o o888o  o888o o8o        `8   `Y8bood8P'  o888ooooood8 o888bood8P'       8""88888P'       o888o        o88o     o8888o    `YbodP'    o888ooooood8     o888o     
                                                                                                                                                                               





*/

I once read through a piece of code of an open source project that was filled with

//don't even try to make sense of this

and

//get out whilst you can

From 3rd party code for a game I worked on;

// This is always 2
#define MAX_PLAYERS 3

From 3rd party code for a game I worked on;

// This is always 2
#define MAX_PLAYERS 3

Back when it was 2nd party code, I'm sure it was 2. =)

I sprinkle my code with such :

# (Coffeescript)

# TODO: derp, move this
numericSort = (a,b) -> a-b

# ...

# TODO: less huehue
ids = (_.pluckDeep models, '*.foo[*].bar[*].id').sort numericSort

I always laugh a little when I found a comment like:

//TODO move this somewhere else

And it literally says "somewhere else", the original developer knew it was a bad place but didn't know where was a good place, so with that comment it's automatically fixed and pasted there forever. It's more funny when you find it in a codebase that's grown a lot over a few years and you think about how many people saw it and didn't want to take the risk of changing it, possibly introducing bugs. Also, it's even more funny when you realize you're one of them... it works there, there are bigger problems in the code, so it's not that bad. Anyway, it has a TODO comment, it will be done some time in the future... right?

hardly the best comment ever, but it acts like it..

      angle_x  = 0;                      /* Set X-axis angle to zero */
      trx      =  mat[5];                 /* And calculate Z-axis angle */

may not seem like an issue until you try to decomment that section of code...

These are hilarious. During my undergrad I was working on a partner project and found this in a 20 line .c file:

;;;;;  ;;;;;;  ;;      ;; ;;             ;;;;;;;  ;;;;;;;  ;;       ;;;;;;;  ;;   ;;  ;;;;; 
;;     ;;      ;;;;  ;;;;                ;;       ;;   ;;  ;;       ;;   ;;  ;;;  ;;  ;;   
;;;;;  ;;;;;;  ;;  ;;  ;; ;;   ;;;;;;    ;;       ;;   ;;  ;;       ;;   ;;  ;; ; ;;  ;;;;;
   ;;  ;;      ;;      ;; ;;             ;;       ;;   ;;  ;;       ;;   ;;  ;;  ;;;     ;;
;;;;;  ;;;;;;  ;;      ;; ;;             ;;;;;;;  ;;;;;;;  ;;;;;;;  ;;;;;;;  ;;   ;;  ;;;;;

Which much to my surprise compiles just fine.

Well d'oh, they're all empty statements, pretty much every language that uses semicolons to finish sentences supports them (I think the only exception is Lua). I have to admit though, when I saw that my first thought was that it was assembly (since semicolons are the usual comment character for assemblers).

Well right, it just doesn't FEEL like it should!

These are hilarious. During my undergrad I was working on a partner project and found this in a 20 line .c file:

;;;;;  ;;;;;;  ;;      ;; ;;             ;;;;;;;  ;;;;;;;  ;;       ;;;;;;;  ;;   ;;  ;;;;; 
;;     ;;      ;;;;  ;;;;                ;;       ;;   ;;  ;;       ;;   ;;  ;;;  ;;  ;;   
;;;;;  ;;;;;;  ;;  ;;  ;; ;;   ;;;;;;    ;;       ;;   ;;  ;;       ;;   ;;  ;; ; ;;  ;;;;;
   ;;  ;;      ;;      ;; ;;             ;;       ;;   ;;  ;;       ;;   ;;  ;;  ;;;     ;;
;;;;;  ;;;;;;  ;;      ;; ;;             ;;;;;;;  ;;;;;;;  ;;;;;;;  ;;;;;;;  ;;   ;;  ;;;;;

Which much to my surprise compiles just fine.

(;) is a null statement and usually compiles to nothing at all.

A compiler I was working with for programming MSP430 microcontrollers would interpret a null statement as an actual NOP instruction. If I had pasted that thing into our code a lot of people would have been mad.

Hah. I imagine that in a microcontroller being able to insert NOPs makes sense though (since it's probably something directly controlling hardware).

I ran across that stackoverflow thread years ago I think, and if memory serves my favorite (though there are so many gems in there!) was something along the lines of

// I'm sorry, I'm so sorry.

Sometimes I'm also partial to something along the lines of

// What kind of idiot wrote this?
bad code goes here
// Oh, it was me.

I'm rather satisfied by the fact that the company I work for has a revision control submission tracker thing that keeps track of what people think are the funniest submit comments.

... O_o ... are the commit comments supposed to be funny?

/**
* 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.
*/

This one made me lol pretty good

One of the best comments I wrote was something along the lines of...

// Somehow multiplying what *should* be divided is what made this possible so DON'T TOUCH IT EVER

That was in one of my first games I wrote in DarkBASIC Professional. A formula that I used for centering the text manually in my own GUI library was supposed to use division for centering text, but it didn't work. Finally I just randomly tried multiplying it and it worked. To this day, I don't know why, I think it was just a total fluke. :P

/**
* 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.
*/

Wow. The rickrolling comment. Awesome!

Note to my future self:

// FIXME - I wrote this file at 4am, re-read EVERYTHING