Documentation Tool : JSDoc - JU-CSE-27/swe-wiki GitHub Wiki
In this post I'll try to cover everything you need to know to get started with JSDoc. I'll also share with you some other cool stuff I learned about #### it that you might find useful.
- Installation
-
Usage
[] Document
[] Export
[] Export files or folders
[] Export all files recursively
[] Use a configuration file
-
Other cool stuff about JSDoc
[] Built-in support in VSCode
[] Use a custom layout
[] JSDoc and Swagger
[] Know any other interesting JSDoc feature?
Follow the steps showed in the YouTube Video below (Link Given):
Video Link: Installation
Github Page: Installation
Follow the steps showed in the YouTube Video below to have an idea about how to generate documentation from Java source codes using “JavaDoc” documentation tool (Link Given):
Video Link: Using JSDoc
Blog Page: Using JSDoc
-
A snippet that builds the JSDoc annotation structure for you when you type /** (and then press enter) before a function declaration.
-
Rich hover information
-
Info about the function signature as you're using it