you are viewing a single comment's thread
view the rest of the comments
[–] 2 points 2 years ago (1 child)

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.

  • source
  • parent
  • hideshow 2 child comments