AutoDoc ChatGPT

Autodoc-Chatgpt

Autodoc-Chatgpt-это скрипт Python, который использует мощность модели CHATGPT для автоматического генерации документации для любого языка программирования.

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

Начиная

Установка

Клонировать это хранилище в местной машине:

git clone https://github.com/awekrx/AutoDoc-ChatGPT.git

Затем установите необходимые пакеты:

pip install -r requirements.txt

Поддерживаемые языки программирования

• Питон
• JavaScript
• Машинопись
• Идти
• C#
• C ++
• PHP
• Рубин
• Ржавчина
• Ява
• Котлин

И другие ...

disclaimer : TypeScript и Javscript имеет некоторые ошибки и находятся под тестированием

disclaimer_2.0 : существует известная ошибка, комментирующая файлы с 2 или более классами, которые имеют методы с тем же именем.

Использование

Редактировать конфигурацию

Откройте config.ini и добавьте там email и password если вы не используете авторизацию OAuth. В противном случае откройте CHATGPT и получите печенье __Secure-next-auth.session-token и напишите его на session-token .

Начинать

py main.py -file " path to the file "

Путь к файлу может быть относительным или абсолютным.

После выполнения файл yourfilename_commented.language создается в папке с желаемым файлом.

ИЛИ

py main.py -file " path to the file "

Не рекомендуется, мало протестировано. Вы можете указать файл с опцией комментария для создания таких комментариев.

Пример использования

Альтернативное использование

Вы также можете использовать это в качестве функции в Python.

 from modules . autodoc import AutoDoc
import configparser

config = configparser . ConfigParser ()
config . read ( "config.ini" )

auth = {
    "email" : config [ "ChatGPT" ][ "email" ],
    "password" : config [ "ChatGPT" ][ "password" ],
    "session_token" : config [ "ChatGPT" ][ "session_token" ]
}

result = AutoDoc (
        auth ,
        "Code for commenting" ,
        "language code" ,
        "example comment model (optional)"
    ). start ()
print ( result )
# out: Code with comments 

Отказ от ответственности

Не всегда создает правильные комментарии. Это не всегда значит то, что вы хотите. Используйте в качестве проекта комментариев, которые могут быть отредактированы.

Лицензия

Этот проект лицензирован по лицензии MIT.

Благодарности

Большое спасибо за разработку ИИ и отдельно, за то, что он генерировал ReadMe.

А также Acheong08 для создания CHATGPT.