Генерация API-документации по коду в заданном формате

  • text-to-text

(от codex-master )

  • text-to-text

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

Создай полную API-документацию по коду на основе:
- programming_language
- documentation_type
- audience
- code_snippet

Выдай только корректный documentation_type и соблюдай такую структуру:
1. Краткое описание модуля или библиотеки.
2. Список экспортируемых или общедоступных сущностей.
3. Для каждой сущности в отдельной подглаве:
   - название;
   - сигнатура в синтаксисе programming_language;
   - назначение и поведение;
   - параметры;
   - возвращаемые значения;
   - исключения и ошибки;
   - 2-3 примера использования;
   - замечания по производительности, побочным эффектам, потокобезопасности и ограничениям;
   - советы по отладке и типичным проблемам интеграции.
4. Примечания и предположения.
5. Сопутствующие ресурсы, если они действительно нужны.

Дополнительные правила
- Используй подсветку кода для programming_language.
- Если типы не заданы явно, помечай их как inferred и кратко объясняй основание.
- Если код содержит HTTP-эндпоинты или сетевые вызовы, добавь таблицу маршрутов, методов, параметров и типичных ответов.
- Если код асинхронный, покажи пример асинхронного вызова.
- Не придумывай функциональность: при неоднозначности перечисляй допущения.
- Если код большой, структурируй документацию по модулям и добавь оглавление.

Попробуйте этот промпт

ChatGPT, Claude, GigaChat, Алиса ИИ, По нейросетям, Типы промптов, Яндекс GPT