The Art Of Commenting Code

Ever Since the Appearance of TDD

Comments have started been replaced from a separate unit test. At least this happens in theory….

After numerous head-wall-banging sessions though, even at large companies where they tend to have a more standardized method of coding with large codebases we often find many, many good gems.

Commenting is art! Trolling while commenting is a given!

Have a look below and for crying out loud laugh until you break 🙂

Personal Favorites :

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 = 42 

And another one, which by the way I have said it many times :

When I wrote this, only God and I understood what I was doing

Now, God only knows

Best Comments Ever!

On a relevant note while browsing source code of battle.net

Look what I found!

Screenshot from 2014-03-20 11:14:24
Put on your robe and wizard hat and lets Play Hearthstone ? While binding events with jQuery 😀

And last but not least, from the company’s large codebase  I currently work at:

**********WARNING******************
*********GRANDE KOLODAXTYLO ***************
To solve issue with serializing data coming in different parts of the response array

Kolodaxtylo in greek means “the middle finger”.

And some dummy user names / passenger names in unit tests :

Luke Skywalker, Princess Leia, and in general names from Star Wars Universe.

But also Greek ones:

Lelos Observes

A sidenote here, working primarily on a travel agency booking site, while we all devs use this name for our tests, it turns out that this guy “Lelos Observes” has “traveled” virtually 2-3 times around the world…

Mitros Karamitros, Loula Karaloula and Loulis Kouklentes