什么是 JSDoc 生成器？

JSDoc 生成器是一款零配置的 CLI 工具，旨在解决代码库缺乏文档的问题。通过分析函数签名和逻辑，它会自动注入专业的文档注释，而不会更改实际的代码执行。它是 Openclaw Skills 生态系统的重要组成部分，用于维护整洁、易读且对 IDE 友好的项目。

无论您是处理遗留代码还是准备公开发布库，此工具都能简化文档流程。它支持标准 JSDoc 和以 TypeScript 为中心的 TSDoc 风格，确保您的导出内容具有详尽的参数、返回值和异常说明，从而实现更好的团队协作和入职体验。

下载入口:https://github.com/openclaw/skills/tree/main/skills/lxgicstudios/docs-gen

安装与下载

1. ClawHub CLI

从源直接安装技能的最快方式。

2. 手动安装

将技能文件夹复制到以下位置之一

优先级：工作区 > 本地 > 内置

3. 提示词安装

将此提示词复制到 OpenClaw 即可自动安装。

JSDoc 生成器 应用场景

• 零文档的遗留代码库，需要立即的入职支持。
• 为开源发布或公开消费准备私人项目。
• 为大型工程团队改进 IDE IntelliSense 提示和开发体验。
• 使用 Openclaw Skills 标准在多仓库环境中统一文档风格。

1. 该工具扫描指定的文件、目录或 glob 模式，以识别导出的函数、类和类型。
2. 解析函数签名，识别参数、返回类型和潜在的逻辑驱动异常。
3. AI 引擎分析代码上下文，以推断每个导出的特定用途和行为。
4. 生成标准化的 JSDoc 或 TSDoc 块，并直接注入到相关代码上方的源文件中。
5. 在整个过程中，原始代码逻辑和格式保持完全不变。

JSDoc 生成器 配置指南

确保您已安装 Node.js 18 或更高版本，并且在环境变量中提供了 OpenAI API 密钥。您无需全局安装该软件包；它可以直接通过 npx 运行。

# 设置您的 API 密钥
export OPENAI_API_KEY='your_api_key_here'

# 对源目录运行预览
npx ai-docs src/ --style jsdoc

# 直接将更改应用于文件
npx ai-docs src/ --style tsdoc --write

JSDoc 生成器 数据架构与分类体系

JSDoc 生成器通过将结构化元数据直接注入源文件来组织其输出。它遵循 JavaScript 和 TypeScript 的标准文档分类。

name: jsdoc-gen
description: Add JSDoc or TSDoc comments to your code. Use when documentation is missing.

JSDoc Generator

Your exported functions have no documentation. This tool adds JSDoc or TSDoc comments to all your exports without touching the actual code logic.

One command. Zero config. Just works.

Quick Start

npx ai-docs src/ --style jsdoc

What It Does

• Adds JSDoc/TSDoc comments to exported functions and classes
• Describes parameters, return values, and exceptions
• Preserves all existing code and comments
• Works on files, directories, or glob patterns

Usage Examples

# Preview docs for a directory
npx ai-docs src/ --style jsdoc

# TSDoc style
npx ai-docs src/ --style tsdoc

# Write changes to files
npx ai-docs src/ --style jsdoc --write

# Single file
npx ai-docs src/utils.ts --style jsdoc

# Glob patterns
npx ai-docs "src/**/*.ts" --style tsdoc

Best Practices

• Preview first - run without --write to see what changes
• Focus on exports - internal helpers don't need docs
• Add examples - especially for complex functions
• Review output - AI might miss nuances

When to Use This

• Codebase has zero documentation
• Onboarding requires reading every function
• IDE hints are unhelpful without docs
• Preparing for open source release

Part of the LXGIC Dev Toolkit

This is one of 110+ free developer tools built by LXGIC Studios. No paywalls, no sign-ups, no API keys on free tiers. Just tools that work.

Find more:

• GitHub: https://github.com/LXGIC-Studios
• Twitter: https://x.com/lxgicstudios
• Substack: https://lxgicstudios.substack.com
• Website: https://lxgicstudios.com

Requirements

No install needed. Just run with npx. Node.js 18+ recommended. Needs OPENAI_API_KEY environment variable.

npx ai-docs --help

How It Works

Reads your files, identifies exported functions, classes, and types, then generates appropriate documentation comments. The AI understands the function signatures and infers what each parameter does.

License

MIT. Free forever. Use it however you want.