JSDoc and Python Docstring Skeleton Generator

Create documentation comment skeletons from function signatures.

Use the tool

Why this tool exists

Consistent doc comments start with consistent structure. This generator reads JavaScript, TypeScript or Python function signatures and writes a JSDoc block or a Google-style docstring with every parameter, default value, return type and thrown error already listed, leaving TODO placeholders for the descriptions only a human can write.

It is a parser, not an AI: it will not describe what the function does. Regex-based parsing means unusual syntax may need manual correction. The code is processed locally.

How to use it

  1. Paste the code.
  2. Choose JavaScript/TypeScript or Python.
  3. Paste each block above its function and write the descriptions.

Frequently asked questions

Does it write the descriptions?

No, only the structure; the TODO lines are yours to fill.

Which docstring style?

JSDoc for JS/TS and Google style for Python.

Is code uploaded?

No.