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

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

by jyothi • 16 years ago

2 3 16 years ago

jyothi• 16 years ago

Some of my favourites:

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


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


    Exception up = new Exception("Something is really wrong.");
    throw up;  //ha ha

tzs• 16 years ago

From Unix, Sixth Edition:

    /*
     * If the new process paused because it was
     * swapped out, set the stack level to the last call
     * to savu(u_ssav).  This means that the return
     * actually returns from the last routine which did
     * the savu.
     *
     * You are not expected to understand this.
     */

shelfu• 16 years ago

My favorite would be a comment in some generated html (no other comments around it

Later it was "fixed"

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

Related Stories