What is JSDoc and Where to Start?
JSDoc is a specific syntax to document your code. There are a few advantages to use it:
The documentation is directly where it's useful (in the code). This way, it's also much easier to update when changes are made to the code.
It allows IDEs to display information about the documented code (especially useful for functions parameters).
In some context, the jslint can detect types errors.
It can be used by external tools to compile all your documentation with other people (like for audit purposes).
Here is a post on devhint providing a cheat sheet to learn how to add those docs to your code.
