710

submitted 11 months ago by CowsLookLikeMaps@sh.itjust.works to c/programmer_humor@programming.dev

97 comments fedilink hide all child comments

you are viewing a single comment's thread
view the rest of the comments

[-] onlinepersona@programming.dev 117 points 11 months ago

[-] philm@programming.dev 12 points 11 months ago

Yeah, but unironic...

If your code needs comments, it's either because it's unnecessarily complex/convoluted, or because there's more thought in it (e.g. complex mathematic operations, or edge-cases etc.). Comments just often don't age well IME, and when people are "forced" to read the (hopefully readable) code, they will more likely understand what is really happening, and the relevant design decisions.

Good video I really recommend: https://www.youtube.com/watch?v=Bf7vDBBOBUA

[-] potustheplant@feddit.nl 30 points 11 months ago

That's like saying a book's synopsis shouldn't exist because you can just read the whole book. Sometimes comments can save you a lot of time and point you in the right direction.

[-] philm@programming.dev 2 points 11 months ago

Nah, it's not, code is modular (IME should be kinda tree-structured), a book is linear.

So the API should be in your analogy the synopsis. And I haven't said, that there shouldn't be any comments. E.g. doc-comments above functions, explaining the use-cases and showing examples are good practice.