JSDoc generator for JavaScript, TypeScript using AI. (VSCode extension)

Overview

DocTypes

JSDoc generator for JavaScript, TypeScript using AI.

demo


Sample

  • Class
/**
 * Exporting the class User, which extends the class UserAbstract
 * and implements the interface PersonInterface.
 *
 * @class
 * @name User
 * @kind class
 * @extends UserAbstract
 * @implements PersonInterface
 * @exports
 */
export class User extends UserAbstract implements PersonInterface {}
  • Function
/**
 * Exporting a function called `createUserId` that takes a parameter called `nonce`
 * that is a number and returns a value of type `Id`.
 *
 * @function
 * @name createUserId
 * @kind function
 * @param {number} nonce?
 * @returns {Id}
 * @exports
 */
export function createUserId(nonce: number = 0): Id {}
  • Variable
/**
 * Generating a random number between the `MAX` and `MIN` variables.
 *
 * @constant
 * @name perfix
 * @kind variable
 * @memberof createUserId
 * @type {number}
 */
const perfix: number = Math.floor(Math.random() * (MAX - MIN)) + MIN;
  • Interface
/**
 * Exporting the interface.
 *
 * @interface
 * @name PersonInterface
 * @kind interface
 * @exports
 */
export interface PersonInterface {}
  • Type
/**
 * It's a type alias.
 *
 * @typedef
 * @name Id
 * @kind variable
 * @exports
 */
export type Id = string | number;

Shortcut keys

  • linux ctrl+alt+d
  • windows ctrl+alt+d
  • mac cmd+alt+d

Configuration

Name Type
doctypes.mintlifyUserId
The custom Mintlify userId, See Mintlify for more details.
String
Default "4aeafe05-c396-4389-8d77-52e585e41932"
doctypes.mintlifyContext
Type of Mintlify context full of page or single line.
Enum Full , Single
Default Full
doctypes.description
Type of description generation.
Enum Auto , Manual , Off
Default Auto
doctypes.class
Type of @class tag generation.
Enum Auto , Off
Default Auto
doctypes.abstract
Type of @abstract tag generation.
Enum Auto , Off
Default Auto
doctypes.interface
Type of @interface tag generation.
Enum Auto , Off
Default Auto
doctypes.typedef
Type of @typedef tag generation.
Enum Auto , Off
Default Auto
doctypes.enum
Type of @enum tag generation.
Enum Auto , Off
Default Auto
doctypes.async
Type of @async tag generation.
Enum Auto , Off
Default Auto
doctypes.function
Type of @function tag generation.
Enum Auto , Off
Default Auto
doctypes.variable
Type of @variable tag generation.
Enum Auto , Off
Default Auto
doctypes.name
Type of @name tag generation.
Enum Auto , Off
Default Auto
doctypes.kind
Type of @kind tag generation.
Enum Auto , Off
Default Auto
doctypes.memberof
Type of @memberof tag generation.
Enum Auto , Off
Default Auto
doctypes.public
Type of @public tag generation.
Enum Auto , Off
Default Auto
doctypes.private
Type of @private tag generation.
Enum Auto , Off
Default Auto
doctypes.protected
Type of @protected tag generation.
Enum Auto , Off
Default Auto
doctypes.readonly
Type of @readonly tag generation.
Enum Auto , Off
Default Auto
doctypes.instance
Type of @instance tag generation.
Enum Auto , Off
Default Auto
doctypes.type
Type of @type tag generation.
Enum Auto , Off
Default Auto
doctypes.param
Type of @param tag generation.
Enum Auto , Off
Default Auto
doctypes.returns
Type of @returns tag generation.
Enum Auto , Off
Default Auto
doctypes.extends
Type of @extends tag generation.
Enum Auto , Off
Default Auto
doctypes.implements
Type of @implements tag generation.
Enum Auto , Off
Default Auto
doctypes.exports
Type of @exports tag generation.
Enum Auto , Off
Default Auto

Supported filetypes

  • .js
  • .ts

Test

  • type.spec.ts
    • type Id (967ms)
    • type Name (150ms)
    • type Age (169ms)
  • interface.spec.ts
    • interface PersonInterface (133ms)
    • id: Id (73ms)
    • name?: Name (74ms)
  • abstract.spec.ts
    • abstract class UserAbstract (175ms)
    • constructor() (44ms)
    • abstract getAge() (125ms)
    • abstract setAge(age: Age) (187ms)
    • get isOld() (91ms)
  • class.spec.ts
    • class User extends UserAbstract implements PersonInterface (240ms)
    • public readonly id: Id (141ms)
    • public name?: Name (91ms)
    • protected _age?: Age (67ms)
    • constructor(id: Id, name?: Name) (136ms)
    • set nickname(name: Name) (105ms)
    • public getNickname: () (143ms)
    • public setAge(age: Age) (204ms)
    • public getAge() (99ms)
  • variable.spec.ts
    • const MIN: 1111 (160ms)
    • const MAX: 999 (137ms)
  • function.spec.ts
    • function createUserId(nonce: number = 0) (224ms)
    • const perfix: number (317ms)
  • index.spec.ts
    • const userId: Id (143ms)
    • const john: User (217ms)
    • john.getAge() (78ms)

Note

Description values are generated by Mintlify AI.

You might also like...

💻 VSCode Extension for AdonisJS

💻 VSCode Extension for AdonisJS

💻 Official AdonisJS extension for VSCode Features Use all Adonis Assembler commands ( make:* ) Migrate and seed your database ( db:*, migration:* ) V

Nov 9, 2022

VSCode extension with helpful code snippets for SolidJS.

Solid Snippets VSCode extension with helpful code snippets for SolidJS. GET THE EXTENSION Snippets Trigger Content Languages JSX sinput→ Input two-way

Dec 8, 2022

Optimized dracula theme vscode extension for flutter, web, electron and golang development.

Optimized dracula theme vscode extension for flutter, web, electron and golang development.

Optimized Dracula Theme A color theme inspired by dracula color theme. This color theme is not based on dracula color theme. The color styles are simi

Jul 11, 2022

a vscode extension for http response data auto transform ts type.

a vscode extension for http response data auto transform ts type.

Api2ts 这是一个自动将 http 的响应数据转化为 ts 的类型,使用 json-to-ts 做的。 Features 框选配置项后,使用快捷键 alt+Q : 请求参数配置文件 在根目录下创建 Api2ts.config.json 文件,配置项如下: { "baseURL": "http

Jun 30, 2022

An enhanced VSCode extension for the Move programming language.

Move Analyzer Plus Provides language support for the Move programming language. Install on the VSCode Extension Marketplace: Move Analyzer Plus on the

Aug 12, 2022

Simple and intuitive API Client made into a VSCode extension 😊

Simple and intuitive API Client made into a VSCode extension 😊

REST API Client Simple and intuitive API Client made into a VSCode extension. Visual Studio Marketplace • Repository • Releases Visual Studio Code ext

Dec 23, 2022

🔎 (Draft!) VSCode extension to show the search results in a tree view

🔎 (Draft!) VSCode extension to show the search results in a tree view

vscode-search-tree 🔎 (Draft!) VSCode extension to show the search results in a tree view The work on this extension is on-pause for now since VSCode

Sep 7, 2022

Lightweight VSCode extension for Ruby.

Lightweight VSCode extension for Ruby.

vscode-ruby-light Lightweight VSCode extension for Ruby. Install Install via Visual Studio Marketplace: Ruby Light - Visual Studio Marketplace For Dia

Jan 2, 2023

🧪 A Japa extension for VSCode

🧪 A Japa extension for VSCode

🧪 Japa extension for VSCode Features Run tests without typing anything. Either with a shortcut, or via Code Lenses Support multiple workspaces Suppor

Sep 27, 2022
Comments
  • A problem with generics

    A problem with generics

    When using generic parameters, function tags are ignored.

    public call<T = any>(config?: AxiosRequestConfig): Promise<AxiosResponse<T>> {
        return this.request<T>({
            ...config,
            ...this.config,
        })
    }
    
    bug 
    opened by dalirnet 0
Releases(v1.0.3)
Hemsida för personer i Sverige som kan och vill erbjuda boende till människor på flykt

Getting Started with Create React App This project was bootstrapped with Create React App. Available Scripts In the project directory, you can run: np

null 4 May 3, 2022
Kurs-repo för kursen Webbserver och Databaser

Webbserver och databaser This repository is meant for CME students to access exercises and codealongs that happen throughout the course. I hope you wi

null 14 Jan 3, 2023
VSCode Extension & utilities for exploring TypeScript type information

ts-type-explorer VSCode Extension & utilities to explore type information in TypeScript projects. Installation Check out the releases page to download

Max Stoumen 6 Nov 20, 2022
📜 Snippet generator for VSCode

Snippet Generator ?? Snippet generator for VSCode ?? Install Via Marketplace Command: Generate Snippet Inspired By Johnson Chu's comment snippet-gener

Wenfang Du 40 Jan 2, 2023
A vscode extension to quickly print variable, variable type, tensor shape etc by using shortcuts

Quick Python Print This repo is inspired by "Python Quick Print". "Python Quick Print" can quickly print out variables on the console by using shortcu

weida wang 5 Oct 28, 2022
Obsidian text generator Plugin Text generator using GPT-3 (OpenAI)

is a handy plugin for Obsidian that helps you generate text content using the powerful language model GP

null 356 Dec 29, 2022
VSCode extension that creates overlay for your Broadcasting Software of choice.

BSOverlay VSCode extension that creates an overlay for your Broadcasting Software of choice. Documentation Please refer to the Wiki Section. Installin

chocoearly44 4 Sep 30, 2022
VSCode extension for managing text selection.

Selection Manager This Visual Studio Code extension will allow you to manage selected text. The aim of this extension is to increase productivity by u

Sanel Hadžini 2 Apr 12, 2022
VSCode extension for the rickroll-lang programming language (incomplete)

Rickroll-Lang VSCode Extension The Rick Roll programming language is a rickroll based, process oriented, dynamic, strong, esoteric programming languag

Siddhesh Zantye 6 Oct 10, 2022
NextJS VScode extension to visualize component tree.

Nexus A component tree extension for NextJS Report Bugs · Request Features Table of Contents About The Project Built With Installation Getting Started

OSLabs Beta 62 Nov 24, 2022