Summary: Having an insightful comment for a function parameter is often
critical, but when the parameters to a function are well named and
self-explanatory, adding a redundant description just adds noise to the
docs and creates more work for both the author and the consumer.
For example:
Summary: Having an insightful comment for a function parameter is often critical, but when the parameters to a function are well named and self-explanatory, adding a redundant description just adds noise to the docs and creates more work for both the author and the consumer. For example:
In a function named 'divide'
In a function named 'getTrip'
Please don't make these comments mandatory. Setting the configuration based on: http://eslint.org/docs/rules/valid-jsdoc.html