# code-documentation

Скилл для написания документации прямо в коде: JSDoc, Python-докстринги, JavaDoc, комментарии и описания API. Пригодится, когда нужно задокументировать функции и классы, а не переписывать их вслепую.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 492 установки · ★ 371
- Автор: aj-geddes
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/aj-geddes/useful-ai-prompts/tree/HEAD/skills/code-documentation/SKILL.md
- Обновлён: 2026-03-04
- HTML: https://affpapa.org/nevibecode/skills/aj-geddes-code-documentation

## Что делает

Скилл задаёт агенту стандарты оформления кода на разных языках. Он покрывает документацию функций и классов, JSDoc для JavaScript и TypeScript, Python-докстринги, JavaDoc, встроенные комментарии, описания типов и примеры использования внутри кода. Внутри — краткий стартовый пример на JavaScript и каталог `references/` с подробными разборами: документация функций, классов, типов и модулей.

Правила простые и по делу. Документируй публичные API, добавляй примеры вызова, описывай параметры, возвращаемые значения и исключения. Комментарий объясняет «почему», а не «что» — очевидное писать не надо. Отдельно оговорено, чего делать нельзя: оставлять закомментированный код, писать вводящие в заблуждение комментарии, забывать обновить описание после правки кода.

Скилл ставится в шесть платформ, но структура файлов у каждой своя: в Claude это `~/.claude/skills/code-documentation/SKILL.md`, в Cursor — `.cursor/skills/code-documentation/SKILL.md`. Если проект уже живёт на своём стиле комментариев, скилл будет тянуть код к описанным стандартам — это повод проверить, совпадают ли они.

## Установка

### Claude Code (родная платформа)

1. **Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill code-documentation -a claude-code
```

2. **Вручную: положить файлы**
- Файл: `~/.claude/skills/code-documentation/SKILL.md` — Папка скилла целиком; для одного проекта — .claude/skills/code-documentation/

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill code-documentation -a codex
```

2. **Вручную: положить файлы**
- Файл: `.agents/skills/code-documentation/SKILL.md` — Для всех проектов — ~/.agents/skills/

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill code-documentation -a cursor
```

2. **Вручную: положить файлы**
- Файл: `.cursor/skills/code-documentation/SKILL.md` — Cursor читает и .agents/skills/, и .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install aj-geddes/useful-ai-prompts code-documentation
```

2. **Вручную: положить файлы**
- Файл: `.github/skills/code-documentation/SKILL.md`

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill code-documentation -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/aj-geddes/useful-ai-prompts --path skills/code-documentation
```

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/skills/code-documentation/SKILL.md` — Старый путь .windsurf/skills/ тоже читается

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill code-documentation -a opencode
```

### Claude.ai

**Claude.ai**
- Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/aj-geddes/useful-ai-prompts/tree/HEAD/skills/code-documentation/SKILL.md

## Когда брать
- задокументировать публичные функции и классы по стандарту языка
- написать JSDoc для модуля на JavaScript или TypeScript
- оформить Python-докстринги с параметрами и исключениями
- добавить примеры вызова к сложной функции
- описать типы и модуль целиком, а не отдельную функцию

## Примеры запросов агенту
- задокументируй функции в `src/utils/price.js` по стандарту JSDoc
- добавь докстринги к классу в `models/user.py` с примерами вызова
- пройдись по модулю и допиши комментарии там, где логика неочевидна

## Похожие
- [code-documenter](https://affpapa.org/nevibecode/skills/httpsgithubcomjeffallan-code-documenter.md) — скилл · ★ 4676
- [documentation](https://affpapa.org/nevibecode/skills/documentation.md) — скилл · 10300 установок
- [api-reference-documentation](https://affpapa.org/nevibecode/skills/secondsky-api-reference-documentation.md) — скилл · 454 установки
- [jsdoc-typescript-docs](https://affpapa.org/nevibecode/skills/jsdoc-typescript-docs.md) — скилл · 547 установок
- [golang-documentation](https://affpapa.org/nevibecode/skills/golang-documentation.md) — скилл · 40400 установок

## Другие версии с тем же именем
- [code-documentation · bytedance](https://affpapa.org/nevibecode/skills/code-documentation.md) — 1900 установок
- [code-documentation · moizibnyousaf](https://affpapa.org/nevibecode/skills/moizibnyousaf-code-documentation.md) — 563 установки

Из того же набора: [aj-geddes/useful-ai-prompts](https://affpapa.org/nevibecode/by/aj-geddes/useful-ai-prompts.md) — 118 карточек

_Часть страницы не вошла по размеру — она есть в HTML-версии._

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md