Documentation Tool : JSDoc - JU-CSE-27/swe-wiki GitHub Wiki

Documentation Tool: JSDoc

Capture

Introduction

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.

Table of contents

Installation Process:

Follow the steps showed in the YouTube Video below (Link Given):
Video Link: Installation
Github Page: Installation

Using JSDoc:

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

Source Code Documentation Example:

Source Code:

Capture

Other cool stuff about JSDoc Built in support in VSCode:

  • A snippet that builds the JSDoc annotation structure for you when you type /** (and then press enter) before a function declaration. Capture2

  • Rich hover information Capture2

  • Info about the function signature as you're using it Capture2

Note: For more info about JSDoc support in VSCode check VSCode docs.

⚠️ **GitHub.com Fallback** ⚠️