Find a way to document code

[ascariandrea]

requirements

The code documentation should be enforced, at least for some cases, to let external devs understand better how app works, to improve code quality and organization.

specs

For "documentation" I don't mean jsdoc or any other standard, but I'm referring to the concept itself. So we need to define first what parts of code need to be documented and how.

misc

A possible solution could be an eslint rule (or a combo of rules):

• require-jsdoc
• valid-jsdoc

but could be a lot of overhead.

[gabro]

The code documentation should be enforced

This is a bit too "solution-oriented".

I would rather say: "The code should be understandable".

Inline documentation is just one way of doing it. Other possible approaches (not mutually exclusive):

• type annotations (flow or similar)
• tests
• readmes
• etc...

About enforcing documentation on every function, I find it an unnecessary overhead that would often be useless.