this post was submitted on 26 Nov 2023
710 points (89.3% liked)

Programmer Humor

19453 readers
69 users here now

Welcome to Programmer Humor!

This is a place where you can post jokes, memes, humor, etc. related to programming!

For sharing awful code theres also Programming Horror.

Rules

founded 1 year ago
MODERATORS
 
you are viewing a single comment's thread
view the rest of the comments
[–] [email protected] 30 points 11 months ago (2 children)

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 2 points 11 months ago (1 children)

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.

[–] [email protected] 1 points 11 months ago

Books can be modular as well (ever heard of "Rayuela" by Cortazar?) But that's beside the point. The analogy is fine and it works.