An API documentation generator for JavaScript. (by jsdoc)

JSDoc Alternatives

Similar projects and alternatives to JSDoc

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a better JSDoc alternative or higher similarity.

JSDoc reviews and mentions

Posts with mentions or reviews of JSDoc. We have used some of these posts to build our list of alternatives and similar projects. The last one was on 2023-08-27.
  • The Complete 2023 Guide to Learning TypeScript - From Beginner to Advanced
    5 projects | dev.to | 27 Aug 2023
    Document types with JSDoc annotations
  • My opinionated JavaScript package template repository - zero config, start immediately
    8 projects | dev.to | 8 Aug 2023
    📚 JSDoc for documentation and jsdoc-to-markdown to create docs as markdown files
  • "react-next-tilt" and "react-flip-tilt" NPM Packages
    13 projects | dev.to | 2 Aug 2023
    I was already familiar with JSDoc from writing prop descriptions for my previous NPM packages, but I decided to go all in and provide more/better descriptions. I added the following information for the props of both components:
  • Supercharge Your Node.js Development with This Starter Configuration
    4 projects | dev.to | 19 Jul 2023
    JSDoc can be a powerful tool not only for generating TypeScript types but also for enabling type checking in your JavaScript code. By providing type annotations through JSDoc comments, you can improve code clarity, maintainability, and catch potential errors early on. In this section, we'll explore how to use JSDoc to generate TypeScript types and discuss the benefits of incorporating type checking into your development process.
  • Documenting recommended use of basic components
    3 projects | /r/reactjs | 3 Jun 2023
    Use JS Doc and Typescript for full editor annotation and autocomplete.
  • Comments - What's Your Style?
    3 projects | /r/webdev | 20 May 2023
    I use JSDoc annotations, and jsdoc package to auto-generate MarkDown and HTML documentation. I use it for [this website](zuixjs.org/). It's open source.
  • Ditching TypeScript for JavaScript
    3 projects | news.ycombinator.com | 6 May 2023
  • Mastering JSDoc: the complete guide for Javascript developers
    3 projects | dev.to | 23 Apr 2023
    JSDoc is a markup language used to describe the structure and behavior of Javascript code. It provides a standard way of documenting code so that other developers can easily understand what each function, method, or class does, its input parameters, return values, and more.
  • Boost Your JavaScript with JSDoc Typing
    5 projects | dev.to | 8 Apr 2023
    You can also use more complex Markdown features like lists and tables. Check out the [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) from Adam Pritchard for more information. ### Other JSDoc tags 📚 There are a few other JSDoc tags that you may find useful: - `@function` or `@func`: Documents a function or method. - `@class`: Documents a class constructor. - `@constructor`: Indicates that a function is a constructor for a class. - `@extends` or `@augments`: Indicates that a class or type extends another class or type. - `@implements`: Indicates that a class or type implements an interface. - `@namespace`: Groups related items, such as functions, classes, or types, under a common namespace. - `@memberof`: Specifies that an item belongs to a class, namespace, or module. - `@ignore`: Tells JSDoc to exclude an item from the generated documentation. - `@deprecated`: Marks a function, class, or property as deprecated, indicating it should no longer be used. - `@since`: Documents the version when an item was introduced. And many more. You can find a full list of JSDoc tags [here](https://jsdoc.app/). Ok ok, enough of the theory. Let's see how we can use JSDoc in practice. ![Reality Check Meme](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/polug716a3hs9lgwr8tf.gif) ## Using JSDoc in practice 🏄‍♂️ There are a few challenges when starting to use JSDoc in your project. So this section will focus on these challenges and how you can overcome them. ### How to get the most out of JSDoc In this post I'm going to stick with VSCode. If you're using another editor, you can still follow along, but you might have to look up how to configure things in your editor. VSCode has built-in support for JSDoc. This means that you can get a lot of the JSDoc benefits without having to install any additional extensions. But there are a few things that you can do to get even more out of JSDoc. Enabling the checkJs option in your `jsconfig.json` file will make the editor display errors for type mismatches, even in JavaScript files. Place it in the root of your project or in the folder where you want to enable type checking. This file can look like this: ```json { "compilerOptions": { "checkJs": true, } }
  • A 'CSS reset' for TypeScript, improving types for common JavaScript API's
    8 projects | news.ycombinator.com | 2 Mar 2023
    > You can import types now

    When using TypeScript to avoid using TypeScript, yeah. It's not valid JSDoc: https://github.com/jsdoc/jsdoc/issues/1645

  • A note from our sponsor - Mergify
    blog.mergify.com | 23 Sep 2023
    Managing outdated pull requests is time-consuming. Mergify's Merge Queue automates your pull request management & merging. It's fully integrated to GitHub & coordinated with any CI. Start focusing on code. Try Mergify for free. Learn more →


Basic JSDoc repo stats
4 days ago

jsdoc/jsdoc is an open source project licensed under Apache License 2.0 which is an OSI approved license.

The primary programming language of JSDoc is JavaScript.

Collect and Analyze Billions of Data Points in Real Time
Manage all types of time series data in a single, purpose-built database. Run at any scale in any environment in the cloud, on-premises, or at the edge.