Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

jsdoc

Package Overview
Dependencies
Maintainers
1
Versions
51
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

jsdoc

An API documentation generator for JavaScript.

  • 4.0.4
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1.7M
decreased by-32.97%
Maintainers
1
Weekly downloads
 
Created

What is jsdoc?

JSDoc is a documentation generator for JavaScript. It parses comments in your source code with JSDoc tags and generates an HTML documentation website.

What are jsdoc's main functionalities?

Generating API documentation

This code sample shows how to use JSDoc comments to document a constructor function for a book. When JSDoc processes this, it will generate documentation for the Book function, including its parameters and their types.

/**
 * Represents a book.
 * @constructor
 * @param {string} title - The title of the book.
 * @param {string} author - The author of the book.
 */
function Book(title, author) {
  this.title = title;
  this.author = author;
}

Documenting a class and its methods

This code sample demonstrates how to document a class and its constructor, as well as a method within the class. JSDoc will generate documentation for the Point class, its constructor, and the getDistanceTo method, including parameter and return types.

/**
 * Class representing a point.
 */
 class Point {
   /**
    * Create a point.
    * @param {number} x - The x value.
    * @param {number} y - The y value.
    */
   constructor(x, y) {
     this.x = x;
     this.y = y;
   }

   /**
    * Get the distance from this point to another point.
    * @param {Point} point - The point to get the distance to.
    * @returns {number} The distance.
    */
   getDistanceTo(point) {
     // ... implementation ...
   }
 }

Documenting module exports

This code sample shows how to document a module and a function that it exports. JSDoc will generate documentation for the module and the exported function, including the function's parameters and return value.

/**
 * @module myModule
 */

/**
 * A function that does something.
 * @param {number} input - The input number.
 * @returns {number} The result.
 */
exports.myFunction = function(input) {
  // ... implementation ...
};

Other packages similar to jsdoc

Keywords

FAQs

Package last updated on 19 Oct 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc