Slashdot Mirror

← Back to Stories (view on slashdot.org)

How to Write Comments

Posted by CmdrTaco on from the no-not-the-slashdot-kind dept.

Denis Krukovsky writes "Should I write comments? What is a good comment? Is it possible to comment a class in 5 minutes? See " Everybody knows that good code is self documenting- which is why my prof in college demanded we write in Ada. I instead suggest commenting in haiku.

6 of 556 comments (clear)

  1. Ditch the signatures by Anonymous Coward · · Score: -1, Offtopic

    Sigs are useless and annoying. Usually, it's a one-liner obscure geek reference that nobody cares about.

    ---------------
    42 - That's my sign. George. All the way. Hooplah!

  2. Dupe! by tpgp · · Score: 1, Offtopic

    Covered here

    Oh... you meant code comments... never mind!

    --
    My pics.
  3. OMG First Post by minginqunt · · Score: 0, Offtopic

    KDE SUXX0rs. All the kewl kidz use teh Macs now!

    ---

    Now that's a *great* comment. Lame, inaccurate, ignorable, irritating, worthless.

    If I keep this up in my code, it'll be so unmaintainable by any other, I'll be secure in my job for life.

    Martin

  4. And I thought... by billyjoeray · · Score: 0, Offtopic

    This was going to be a story on how to write slashdot comments..

    --
    This sig will make it clear that ANYONE can use this post for ANY purpose WITHOUT the written consent of the NFL.
  5. Re:Unified theory of commenting by Anonymous Coward · · Score: -1, Offtopic

    // CowboyNeal stole this comment.

  6. Re:You mean by DavidTC · · Score: 0, Offtopic
    That 'praying the Lord's Prayer' thing has always confused me.

    Especially when people say it in King James English!

    Here's the template as I understand it:

    You are great, God. Do your will on earth. Please continue to keep us fed and whatnot. Please help us forgive other people.

    Amen.

    Basically, it's: Jesus's First Law (Love the Lord with all your heart), remembering that God has a plan that you don't know and it comes before any requests you make, then any random requests you might have anyway, and then a request for Him to help you with Jesus's Second Law. (Love other people as if they were yourself)

    It's a very nice prayer, with all the priorities, and someone could probably preach a whole sermon on it.

    Instead, people treat it like it's some sort of poem, and don't even listen to what it says.

    --
    If corporations are people, aren't stockholders guilty of slavery?