Open olleharstedt opened 7 years ago
Naive question: What's the benefit to using JSDoc?
@param
. Return values would use @return
. These conventions are used for PHPDoc and Java, too (and maybe other languages), making it easy to read and get an overview. It's especially useful for dynamically typed language, where the type of an argument might not be obvious (depending on naming conventions etc).It's google approved (https://google.github.io/styleguide/jsguide.html#jsdoc); I think it's a good idea.
All functions should be documented using JSDoc conventions.