AutoDoc ChatGPT

Autodoc-Chatgpt

Autodoc-ChatGPT adalah skrip Python yang memanfaatkan kekuatan model chatgpt untuk secara otomatis menghasilkan dokumentasi untuk bahasa pemrograman apa pun.

Dengan Autodoc-ChatGPT, Anda dapat dengan mudah menghasilkan dokumentasi komprehensif untuk basis kode Anda. Cukup berikan jalur untuk file yang ingin Anda dokumentasikan, dan Autodoc-CHATGPT akan menghasilkan deskripsi terperinci tentang fungsionalitas, parameter, dan nilai pengembalian dalam bahasa alami.

Memulai

Menginstal

Kloning repositori ini ke mesin lokal Anda:

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

Kemudian instal paket yang diperlukan:

pip install -r requirements.txt

Bahasa pemrograman yang didukung

• Python
• Javascript
• Naskah
• Pergi
• C#
• C ++
• Php
• Rubi
• Karat
• Jawa
• Kotlin

Dan lainnya ...

disclaimer : TypeScript dan Javscript memiliki beberapa bug dan sedang dalam pengujian

disclaimer_2.0 : Ada kesalahan berkomentar kesalahan yang diketahui dengan 2 kelas atau lebih yang memiliki metode dengan nama yang sama.

Penggunaan

Edit konfigurasi

Buka config.ini dan tambahkan email dan password di sana jika Anda tidak menggunakan otorisasi OAuth. Kalau tidak, buka chatgpt dan dapatkan __Secure-next-auth.session-token cookie dan tuliskan ke session-token .

Awal

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

Jalur ke file bisa relatif atau absolut.

Setelah eksekusi, file yourfilename_commented.language dibuat di folder dengan file yang diinginkan.

ATAU

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

Tidak direkomendasikan, sedikit diuji. Anda dapat menentukan file dengan opsi komentar untuk membuat komentar tersebut.

Contoh Penggunaan

Penggunaan alternatif

Anda juga dapat menggunakan ini sebagai fungsi di 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 

Penafian

Tidak selalu membuat komentar yang benar. Itu tidak selalu berarti apa yang Anda inginkan. Gunakan sebagai draf komentar yang mungkin perlu diedit.

Lisensi

Proyek ini dilisensikan di bawah lisensi MIT.

Ucapan Terima Kasih

Terima kasih banyak untuk pengembangan AI dan secara terpisah untuk сhatgpt untuk menghasilkan readme.

Dan juga ACHEONG08 untuk membuat chatgpt.