What is the best comment in source code you have ever encountered? • Hacker News Board

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

#11

Post by [deleted] » Fri, Sep 17, 2010, 5:02 AM UTC

[deleted]

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

#12

Post by statictype » Fri, Sep 17, 2010, 5:35 AM UTC

    char  program [1];/* Unwarranted chumminess with compiler. */

First by Dennis Ritchie in his regular expression implementation, and then subsequently copied with the comment intact into all other regular expression implementations ever written.

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

#13

Post by aaronbrethorst » Fri, Sep 17, 2010, 5:53 AM UTC

Here's a category interface in a shipping iPhone app of mine:

    @interface UIScreen (AppleAreAssholes)
    + (CGRect) convertRect:(CGRect)rect toView:(UIView *)view;
    @end

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

#14

Post by neilk » Fri, Sep 17, 2010, 7:23 AM UTC

http://www.flickr.com/photos/straup/2801691670/

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

#15

Post by christefano » Fri, Sep 17, 2010, 8:01 AM UTC

stop(); // Hammertime!

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

#16

Post by m0nty » Fri, Sep 17, 2010, 10:25 AM UTC

"This ain't pretty but neither are you."

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

#17

Post by 10ren » Fri, Sep 17, 2010, 10:56 AM UTC

I hate the way SO only remembers you for a week or two, so when you return, you have to login, going to a separate screen and so on. Why do they have to make it so hard? What's the advantage in forcing frequent logins?

Yeah, I know I should find some other StackExchange site, go there, create an account there, login there, and post this complaint there - but you know, that's just more of the same problem.

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

#18

Post by nivertech » Fri, Sep 17, 2010, 11:50 AM UTC

  /**
   * Today I'm getting discharged from the Army
   * Don't have time to properly comment the code
   * Call me if you have any questions: Name,054-XXXXXXX
   */

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

#19

Post by pmichaud » Fri, Sep 17, 2010, 11:59 AM UTC

I once wrote a haiku to a particularly nasty bug where the offending line had been. I got a call years later when someone found it, they appreciated the humor.

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

#20

Post by edanm » Fri, Sep 17, 2010, 12:38 PM UTC

There are lost of great ones. I especially liked this practical comment:

From the SO answer:

This seems to stop morons from messing my code...

// Autogenerated, do not edit. All changes will be undone.

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