Quick and Easy JSDoc

With AI-tools becoming increasingly available, writing JSDoc comments, or rather generating them, has never been easier. 

To start, let’s look at what JSDoc does in the context of a project within VS-Code. Here is an example function, with JSDoc comments to go with it. 

Now, when I would like to use this function or look at its usage within my code, I have a quick and easy-to-read reference. It also gives helpful details within my code editor, such as derived types.

As a caveat, we should understand how to write these JSDoc comments. If your code is safe to send to an 3rd-party AI service, prompt the service to write JSDoc comment code. Make sure you check the produced JSDoc comments for any adjustments or errors. This is a huge time-saver, as AI is extremely efficient in analyzing and creating comments for your functions. With this bit of AI help, the codebase becomes a more developer-friendly environment with a lower time investment.