• 0 Posts
  • 4 Comments
Joined 1 year ago
cake
Cake day: June 1st, 2023

help-circle



  • Its wild to me that some people hear “your code should be self documenting” and take that to mean “never write comments”.

    All self documenting should mean is I can look at a method and get a general understanding of what it does, and it shouldn’t have any unknown functionality. Specific implementations, design quirks, choices that might only make sense if you know business context should all be comments in your code.

    On the other side of all that I worked with someone who insisted methods were documented college style, the “authors” name, date it was written, what it does, why it’s here, our star sign. I hate that just as much, so much clutter.