gptdoc

Hasilkan komentar dokumentasi dengan model OpenAI

Instal • Dokumentasi • Lisensi

Pratinjau

Fungsi yang diberi label /** @gpt */ mendapatkan komentar dokumen yang dibuat secara otomatis

Sebelum	Setelah
/** @gpt */ function Greet ( name ) { console . log ( `Hello ${ name } ` ) ; }	/** * @autogenerated * @summary Generates a greeting to the passed in name * @param {string} name - The name to greet */ function Greet ( name ) { console . log ( `Hello ${ name } ` ) ; }

Instal di proyek

Instal gptdoc sebagai ketergantungan dev

npm i --save-dev gptdoc 

Menjalankan

node node_modules/gptdoc [args]

Konfigurasi

Anda dapat menentukan file konfigurasi:

node node_modules/gptdoc -c .myconfig

Jika tidak ada yang disediakan, skrip akan mencari .gptdoc

Contoh file Konfigurasi

{
    "DEBUG" : false ,
    "framework" : " JSDOC " ,
    "language" : " JS " ,
    "files" : {
        "src" : " ./src " ,
        "dest" : " ./gpt "
    },
    "openai" : {
        "temperature" : 0.7 ,
        "top_p" : 1 ,
        "max_tokens" : 256 ,
        "model" : " text-davinci-003 "
    }
}

Temukan info lebih lanjut tentang konfigurasi di sini

Kunci API

Tambahkan file .env di direktori root Anda dengan OPENAI_API_KEY

atau atur OPENAI_API_KEY sebagai variabel lingkungan sistem.

temukan kunci API Anda di sini

Dokumentasikan proyek ini

Menjalankan docself di repo yang dikloning akan mendokumentasikan file sumber dalam ./src/

npm run docself

Menjalankan test di repo yang dikloning akan mendokumentasikan ./example/example.js

npm run test 

Berkontribusi

Kritik yang membangun, Isu dan PR sangat kami harapkan!

---

Lisensi MIT