24
anon404
6y

DOCUMENT YOUR MOTHERFUCKING CODE!

Comments
  • 7
  • 1
    @rookiemaverick that's exactly what the guy who worked before me said. I will choke him to death if I find him.
  • 7
    /**
    * This is a PHPDoc to document my code
    * as requested by @souravsharan
    */
    [...all-of-the-code...]

    Check ✓
  • 1
  • 2
    @souravsharan document the code is a vague statement. Document only those methods which are meant to be exposed. You can Google for a better explanation. Also, not documenting or commenting comes with greater responsibility on the writers part.
  • 1
    @rookiemaverick
    × adds entry to Wikipedia: "My Code" ×
  • 1
    @rookiemaverick Thank you. That was very helpful. :-|
  • 1
    "my code speaks for itself".... ¬.¬
  • 1
    And then write unit tests
  • 2
    Fine, I will document it, but no promises keeping it up to date 😎
  • 0
    Words to live by
  • 4
    At my work we have a policy of not commenting bevause the code should speak for itself. (Our code is actually pretty clean so it seems to work for us.)
  • 4
    code is supposed to be s e l f d o c u m e n t i n g
Add Comment