Skip to content

v0.0.1

Compare
Choose a tag to compare
@klmhyeonwoo klmhyeonwoo released this 19 Jan 15:40
· 3 commits to main since this release

Features

Automatic JSDoc Generation:

  • Automatically generates JSDoc comments for functions and variables in JavaScript and TypeScript files.
  • Supports function declarations, arrow functions, and TypeScript types and interfaces.
  • Infers parameter and return types directly from TypeScript annotations to ensure accurate JSDoc comments.

Simple CLI Usage:

  • Process files with an easy command: jsdoc-builder .
  • No additional subcommands required—just specify the file path, and JSDoc comments will be inserted.
  • Structured Output:
    • Generates clean and well-structured JSDoc comments for improved code documentation.
/**
 * @description Function description
 * @param {number} a
 * @param {number} b
 * @returns {number}
 * */
function add(a: number, b: number) {
  return a + b;
}

Installation

  • Install globally with npm install jsdoc-builder -g.
  • Install locally as a dev dependency with npm install jsdoc-builder --save-dev.
jsdoc-builder example.ts

Stay tuned for new features and improvements in upcoming releases.

Full Changelog: https://github.com/klmhyeonwoo/jsdoc-generator/commits/0.0.1