Документировать код
Добавляет к коду документацию: описание функций, параметров и возвращаемых значений — в принятом для языка формате.
Что делает
Читает присланный фрагмент кода и возвращает его с документацией: у каждой функции появляется описание, перечень параметров с их назначением и указание на то, что она возвращает. Оформление берётся то, которое принято для этого языка, — docstring, JSDoc, XML-комментарии. Сам код при этом не переписывается.
Когда пригодится
Проект достался по наследству, и разобраться в чужих функциях быстрее с описаниями. В команде договорились про обязательные комментарии, а старый код без них. Нужно выгрузить документацию генератором, а тот берёт её из комментариев. Пишете библиотеку, которой будут пользоваться другие: без описаний параметров её не примут.
Как заполнить
Код Вставьте фрагмент — функцию, класс, модуль. До 12000 знаков за раз, это несколько сотен строк. Если файл больше, разбейте его на части по границам функций: обрезанный посередине блок разобрать сложнее, и описание выйдет неточным. Отступы и переносы сохраняйте как есть. Язык Выберите язык из списка: Python, JavaScript / TypeScript, SQL, Java, C#, Go, PHP. От выбора зависит формат комментариев, а не только их текст. Если сомневаетесь или во фрагменте смешано несколько языков, поставьте Определить по коду — язык будет распознан по синтаксису.
Что получится
Тот же код целиком, с добавленными комментариями на своих местах — можно скопировать обратно в файл. Логика, имена и порядок строк не меняются, поэтому результат безопасно сравнить с исходником построчно и увидеть, что добавилось только описание. Формулировки стоит перечитать: инструмент описывает то, что видит в коде, и не знает, для чего функция нужна в вашем проекте.
