What is the best comment in source code you have ever encountered?

#1

Post by tszming » Fri, Sep 17, 2010, 1:53 AM UTC

What is the best comment in source code you have ever encountered?
stackoverflow.com

Re: What is the best comment in source code you have ever encountered?

#2

Post by byoung2 » Fri, Sep 17, 2010, 2:04 AM UTC

From an educational app:

if($_GET["action"] == "score") {//that's what she said

Re: What is the best comment in source code you have ever encountered?

#3

Post by heseltine » Fri, Sep 17, 2010, 2:13 AM UTC

This one: http://stackoverflow.com/questions/184618/what-is-the-best-c...

Re: What is the best comment in source code you have ever encountered?

#4

Post by Scott_MacGregor » Fri, Sep 17, 2010, 3:29 AM UTC

Good funny post, that was the best laugh I've had all day. Thanks!

Re: What is the best comment in source code you have ever encountered?

#5

Post by ScottBurson » Fri, Sep 17, 2010, 4:12 AM UTC

In a parser for a config file:

  if (line[0] == '#') continue;   // comment

Re: What is the best comment in source code you have ever encountered?

#6

Post by kraynar » Fri, Sep 17, 2010, 4:20 AM UTC

There's some great stuff in there. I really liked this one:

  // somedev1 -  6/7/02 Adding temporary tracking of Login screen
  // somedev2 -  5/22/07 Temporary my ass

(http://stackoverflow.com/questions/184618/what-is-the-best-c...)

Re: What is the best comment in source code you have ever encountered?

#7

Post by neilc » Fri, Sep 17, 2010, 4:32 AM UTC

Not to be a grouch, but most of this seems puerile and borderline irresponsible to me. Source code should be concise and beautiful, not a repository for unfunny attempts at humor by programmers.

Re: What is the best comment in source code you have ever encountered?

#8

Post by Calamitous » Fri, Sep 17, 2010, 4:48 AM UTC

    // I have to put this part in because Ken is a dick

Re: What is the best comment in source code you have ever encountered?

#9

Post by jacobbijani » Fri, Sep 17, 2010, 4:50 AM UTC

    #Christmas tree initializer  
    toConnect = []  
    toRead =   [  ]  
    toWrite = [    ]   
    primes = [      ]  
    responses = {}  
    remaining = {}

http://stackoverflow.com/questions/184618/what-is-the-best-c...

Re: What is the best comment in source code you have ever encountered?

#10

Post by DiabloD3 » Fri, Sep 17, 2010, 4:52 AM UTC

You just obliterated like 3 hours of my time. Good job!