• LCrawford (unregistered)

    I shouldn't have been frist with this stupid comment.

  • (nodebb)

    Pfft. Many years ago, I ran across a comment that said more or less, "This code doesn't work and I don't know why."

    Happily for me, I wrote neither the code nor the comment.

  • Anon (unregistered) in reply to Steve_The_Cynic

    A very common comment.

  • akozakie (unregistered)

    Whaaat? No Easy Reader Version?!? Am I supposed to read ALL THAT TEXT this time? Come on!

  • (nodebb) in reply to Steve_The_Cynic

    Or sometimes "This code does work and I don't know why.", because from the looks of it couldn't have possibly ever done so.

  • Bogolese (unregistered)

    Obey this sign!

  • Dave Hemming (unregistered)

    Favourite I ever saw: "Do not rewrite this to work in the obviously better way, because then [other function] breaks and we don't know why."

  • Foxglove (unregistered)

    // To do - fix this

    Not so bad, bit useless. Now work with someone (in the days before source control) who doesn't remove the tag after fixing it.

  • Dave (unregistered)

    Friend of mine used to listen to Black Sabbath while coding, and whenever there was some particularly noteworthy lyric he'd add it as a code comment. If there weren't any noteworthy lyrics, the code would end up uncommented.

  • K. (unregistered)

    // This code sometimes randomly stops working an we don't know why

    I once worked at a project where we did know it stopped working due to some straightforward to fix threading issue, but were not allowed to fix it... It caused us to disregard a whole slew of other issues as 'Oh, its the threading problem again' (it wasn't).

  • (nodebb) in reply to Foxglove

    As per 'To do' comment, yes, at least put some 'tag' in the comment so someone with time to refactor/fix can find things to look at. I tend to use 'XXX' because the editor I use will highlight that.

  • Charles Shapiro (unregistered)

    Reminds me of my still favorite error message:

    Obvious Mode Error

    Succinct and to the point.

  • (nodebb) in reply to Charles Shapiro 
    Obvious Mode Error
    So, don't run in Obvious Mode. Try Obscure Mode instead.
  • sizer99 (google)

    Actual comment:

    | TODO: WTF

  • Ulysses (unregistered)

    As I said about Thursday's article...

  • Richard is an ICD-9 code (unregistered)

    no comment

  • Ogre (unregistered)

    Adding to the list of "my favourite" comments: "This is where the miracle needs to happen" I didn't write that code. And it did need a miracle. Preferably the Sodom and Gomorrah kind.

  • NotAThingThatHappens (unregistered)

    As a senior developer there is a golden rule I teach the new guys.

    If you read a piece of code and you have a 'oooh, THAT is what it does' moment. Document it!

  • NotAThingThatHappens (unregistered)

    I also never use Right-Join only left, gives me one less thing to worry/think about.

  • // Todo: Truthiness (unregistered) in reply to sizer99

    I'm happy to report that there are no comments in our code base containing 'WTF' :-)

  • Appalled (unregistered) in reply to NotAThingThatHappens

    So So So So true. Right Joins totally suck.

  • Drone (unregistered)

    My favorite comment of all time (paraphrased):

    // [PersonA] I have no idea what this code does, but it's been here since [8 years previous] and I'm not touching it. // [PersonB, 7 years later] I also have no idea what this does. I'm not touching it either.

  • 🤷 (unregistered)

    "//TODO: Fix this later"

    Finding this in code that has been in production for years isn't nice. It's even worse when you find out that you are responsible for the code and the comment.

Leave a comment on “The Truest Comment”

Log In or post as a guest

Replying to comment #:

Log Out

« Return to Article