code-documenter

仓库创建 2025年10月21日最近提交 2 个月前SkillHot 收录 20 天前

▸ 精选理由

能自动补全注释与 API 文档，提升开发者文档覆盖率

这个 Skill 做什么

生成与校验代码文档、docstrings、OpenAPI 规范与文档站点。

负责生成和校验代码文档、docstrings、OpenAPI/Swagger、JSDoc 以及文档站点和使用手册，让代码和 API 文档可读又规范。用在需要补注释、产出 API 规范或搭建文档门户时，会统一格式、补充示例、校验规范并输出能直接发布的文档。强调机器可验证、一致性和示例驱动，减少文档与代码不同步的问题。

▸ 展开 SKILL.md 英文原文

Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing tutorials and user guides. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, getting started guides.

开发编程文档生成OpenAPI注释通用

1.1w

Stars

984

Forks

仓库内 Skill

+310

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/Jeffallan/claude-skills/main/skills/code-documenter/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/Jeffallan/claude-skills/main/skills/code-documenter/SKILL.md"

SKILL.MD 节选查看完整文件 ↗

# Code Documenter

Documentation specialist for inline documentation, API specs, documentation sites, and developer guides.

## When to Use This Skill

Applies to any task involving code documentation, API specs, or developer-facing guides. See the reference table below for specific sub-topics.

## Core Workflow

1. **Discover** - Ask for format preference and exclusions
2. **Detect** - Identify language and framework
3. **Analyze** - Find undocumented code
4. **Document** - Apply consistent format
5. **Validate** - Test all code examples compile/run:
   - Python: `python -m doctest file.py` for doctest blocks; `pytest --doctest-modules` for module-wide checks
   - TypeScript/JavaScript: `ts

via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有