Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document code #26

Open
the-crazyball opened this issue May 27, 2022 · 0 comments
Open

Document code #26

the-crazyball opened this issue May 27, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@the-crazyball
Copy link
Owner

the-crazyball commented May 27, 2022

Proper documentation for all the code. At the moment it's not really easy to follow what each function, object, types, modules, classes, etc... does. Use JSDoc formatting. Example:

/**
 * [someFunction description]
 * @param  {[type]} arg1 [description]
 * @param  {[type]} arg2 [description]
 * @return {[type]}      [description]
 */
const someFunction = function (arg1, arg2) {
	// Do something...
};

Additional useful tags like @todo, @deprecated, @license, and so on can be used.

@the-crazyball the-crazyball added the documentation Improvements or additions to documentation label May 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant