iiuniversitet.ruЦентр обучения нейросетямОткрыть каталог

Комментарии и docstrings

Добавляет docstrings/JSDoc к публичным функциям.

СкиллРазработано в iiuniversitetCodexНаш материалНужен терминалПроверка не требуется
Скачать архив
Что делает
Добавляет docstrings/JSDoc к публичным функциям.
Когда брать
Когда вы просите: «добавь документацию в код» или «комментарии и docstrings».
Пример запроса
$code-comments добавь документацию в код

Как включить

  1. Скачайте архив и распакуйте его.
  2. Положите папку code-comments в ~/.agents/skills/.
  3. Вызовите скилл командой $code-comments или найдите его через /skills.

Текст

---
name: code-comments
description: "Добавляет docstrings/JSDoc к публичным функциям. Используй, когда пользователь просит: «добавь документацию в код» или «комментарии и docstrings». Не используй для задач вне этой темы."
---

Комментарии и docstrings

Добавляет docstrings/JSDoc к публичным функциям.

Перед началом

Прочитай AGENTS.md и README, определи стек, команды сборки и тестов. Работай в текущей ветке, не трогай несвязанные файлы.

Порядок работы

  1. Найти публичные API.
  2. Написать docstrings.
  3. Описать параметры и примеры.
  4. Проверить генерацию доков.
  5. Проверь результат по правилам ниже и кратко опиши, что сделано.

Формат результата

Diff.

Правила

  • Пиши для человека, который видит проект впервые.
  • Проверяй, что команды из документации реально работают.
  • Не переписывай общую историю Git без подтверждения.

Пример вызова

$code-comments добавь документацию в код

Разработано в iiuniversitet — https://iiuniversitet.ru/?utm_source=bonus&utm_medium=skill&utm_campaign=katalog&utm_content=code-comments

Автор: iiuniversitet. Каталог скиллов iiuniversitet.

Похожие