✨[Feature] Add JSDoc for all JS files
Closed this issue · 3 comments
Is your feature request related to a problem? Please describe.
JSDoc is a markup language used to annotate JavaScript source code files. It has become a standard for code documentation and used widely in the industry.
Describe the solution you would like
Add JSDoc at the beginning of each file.
You may use this site as a doc for JSDoc ->
Issue-Label Bot is automatically applying the label enhancement to this issue, with a confidence of 0.99. Please mark this comment with 👍 or 👎 to give our bot feedback!
Links: app homepage, dashboard and code for this bot.
This should be easy if we use it only as file overviews.
We'll also add JSDOc for all module functions. Any function that is not a module should be excluded. A sample JSDoc for a module will look like -
/**
* Assign the project to an employee.
* @param {Object} employee - The employee who is responsible for the project.
* @param {string} employee.name - The name of the employee.
* @param {string} employee.department - The employee's department.
* @param {number} priority - A positive number representing the priority
*/
function assign(employee, priority) {
// ...
};