13

New pull request rule:

If there are more comments than actual code... REJECTED

Nobody wants your novel on how you came to the conclusion that "_canHazStuff()" is the best possible name for the method.

Comments
  • 7
    I'd rather have too many comments than not enough. I'd vote to ban that rule.
  • 3
    @codeclod Except if you're implementing some kind of highly optimized mathematical stuff and need to comment the what rather than only the why, then the urge to write walls of comments is a code smell: you need to make the code itself clearer.

    When I see more comments than code, my subconscious thinks that there is no way all of these comments are up to date and reflect the code.

    I used to write an absurd lot of comments, then I understood I made my thinking while writing comments. I was wrong.
  • 0
    Mine has LOADS of profanities. One line max
  • 0
    @codeclod I'm right there with you man. This was a joke for people who put comments when they're completely unnecessary.

    //creating an iterator
    int i = 0;
  • 1
    I just wish people would exercise common sense when it comes to comments. Explain it enough to paint the picture to other devs, don't be so terse or verbose that it becomes counterproductive, and for fuck's sake, keep them up to date!
Add Comment