Обновление документации с помощью ИИ

Недавно я занимался обновлением документации для библиотеки CouchdbClient. Помучившись с некоторыми фразами, я решил попробовать использовать ИИ, чтобы он сделал это за меня. У Microsoft есть Copilot как часть поиска Bing в браузере Edge.

В общем, я попросил его сгенерировать документацию и был удивлен тем, насколько хорошо он справляется. Мой запрос звучал так: «Улучши документацию для этого кода на Swift:», после чего следовал исходный код функции.

Он правильно понял контекст, проанализировал исходный код, описал, как он работает, и какие ошибки может вызывать. Он даже добавил некоторые комментарии в сам код. И я не смог бы написать ничего лучше самостоятельно. Поэтому я просто попросил его сделать это для каждой публичной функции в библиотеке, и теперь у меня есть отличная документация. И всё это бесплатно прямо в браузере Edge. Единственное ограничение — длина сообщения, поэтому мне приходилось отправлять функцию за функцией очень осторожно. Использование API было бы быстрее, но так как у меня всего один файл на Swift, я просто использовал браузер.

Позже я попробовал Gemini от Google, к которому они открыли доступ после недавней конференции I/O. Он тоже хорош, но не так хорош, как Copilot. Похоже, Apple DocC не очень нравится формат сгенерированной документации (особенно раздел Throws), поэтому некоторые части отсутствовали. Кроме того, Gemini добавляет меньше деталей, чем Copilot, так что на данный момент мой фаворит — Copilot:

Пора использовать ИИ чаще для таких рутинных задач.