672 читали · 2 года назад
🐍🤖✍️ Документирование кода и проектов на Python с помощью ChatGPT
Научимся создавать документацию к коду, комментарии, руководства к библиотекам и README-файлы с помощью ChatGPT. Данная статья является переводом. Ссылка на оригинал. К счастью, с помощью больших языковых моделей (БЯМ) и таких инструментов, как ChatGPT, можно быстро документировать свой код и проекты на Python. В Python можно документировать код с помощью строк документации (они же docstrings), а затем использовать их для улучшения внешней документации проекта. ChatGPT может оказать большую помощь в написании как docstrings, так и внешней документации...
690 читали · 5 лет назад
Учимся писать строки документации в Python
Все мы когда-то писали такой код, взглянув на который две недели спустя, трудно было понять почему и как он работает. Нам часто приходится иметь дело с плохо документированным кодом. Но так не должно быть...