Документация к коду
Создаёт полную документацию к коду с JSDoc, примерами и README.
НачинающийПромпты для кода
Текст промпта
prompt
Напиши документацию для следующего кода:
```{язык}
{код}
```
Создай:
1. README-секцию: что делает модуль, зачем нужен, как использовать
2. JSDoc / docstring для каждой публичной функции:
- Описание
- @param с типами и описаниями
- @returns с типом и описанием
- @throws (если выбрасывает ошибки)
- @example с реальным примером использования
3. Inline-комментарии к сложным участкам (не к очевидным)
4. Список зависимостей и их назначение
Стиль: технически точный, но понятный мидл-разработчику.Вариации
Вариации этого промпта для других AI-инструментов скоро появятся.
Похожие промпты
Загрузка похожих промптов...