this post was submitted on 26 Nov 2023
707 points (89.2% liked)

Programmer Humor

19817 readers
556 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 2 years ago
MODERATORS
 
you are viewing a single comment's thread
view the rest of the comments
[โ€“] philm@programming.dev 2 points 1 year 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.

[โ€“] potustheplant@feddit.nl 1 points 1 year 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.