search

aldrin312 / AutoCommentingTool

BSD 3-Clause "New" or "Revised" License
2 stars 2 forks source link

Suggestion: Use JSDOCs where applicable #1

Open Mounayer opened 1 month ago

Mounayer commented 1 month ago

Description

While regular comments are great, it is much better to use JSDOCs where applicable, such as above function prototypes, clearly explaining what each parameter is used for, what the function returns, and what it does. Perhaps this can be a great addition?

aldrin312 commented 1 month ago

I believe so too. I do plan to add multiple options for adding comments, like the JSDOC u mention or with just plain commenting.