Nikita Kiselev
01458e3b4c
Some checks failed
Telegram Mini App Shop Builder / Compute version metadata (push) Has been cancelled
Telegram Mini App Shop Builder / Run Frontend tests (push) Has been cancelled
Telegram Mini App Shop Builder / Run Backend tests (push) Has been cancelled
Telegram Mini App Shop Builder / Run PHP_CodeSniffer (push) Has been cancelled
Telegram Mini App Shop Builder / Build module. (push) Has been cancelled
Telegram Mini App Shop Builder / release (push) Has been cancelled
63 lines
2.0 KiB
Markdown
63 lines
2.0 KiB
Markdown
# Промпты для документирования
|
||
|
||
## Документирование класса
|
||
|
||
```
|
||
Добавь PHPDoc документацию для класса [CLASS_NAME]:
|
||
1. Описание класса и его назначения
|
||
2. @package тег
|
||
3. @author тег
|
||
4. Документация для всех публичных методов
|
||
5. Документация для публичных свойств
|
||
6. Примеры использования где уместно
|
||
```
|
||
|
||
## Документирование метода
|
||
|
||
```
|
||
Добавь PHPDoc для метода [METHOD_NAME]:
|
||
1. Описание метода
|
||
2. @param для всех параметров с типами
|
||
3. @return с типом возвращаемого значения
|
||
4. @throws для всех исключений
|
||
5. Примеры использования если сложная логика
|
||
```
|
||
|
||
## Документирование API endpoint
|
||
|
||
```
|
||
Создай документацию для API endpoint [ENDPOINT_NAME]:
|
||
1. Описание назначения
|
||
2. HTTP метод и путь
|
||
3. Параметры запроса (query/body)
|
||
4. Формат ответа (JSON структура)
|
||
5. Коды ошибок
|
||
6. Примеры запросов/ответов
|
||
7. Требования к авторизации
|
||
```
|
||
|
||
## Документирование Vue компонента
|
||
|
||
```
|
||
Добавь документацию для Vue компонента [COMPONENT_NAME]:
|
||
1. Описание компонента
|
||
2. Props с типами и описаниями
|
||
3. Emits с описаниями
|
||
4. Slots если есть
|
||
5. Примеры использования
|
||
6. Зависимости от других компонентов
|
||
```
|
||
|
||
## Создание README
|
||
|
||
```
|
||
Создай README.md для [MODULE/COMPONENT]:
|
||
1. Описание назначения
|
||
2. Установка/настройка
|
||
3. Использование с примерами
|
||
4. API документация
|
||
5. Конфигурация
|
||
6. Troubleshooting
|
||
```
|
||
|