jotbot
v0.1.5
JotBot dengan mulus menghasilkan dokumentasi kode untuk proyek GO dan TypeScript Anda, menjembatani kesenjangan antara kode komprehensif dan dokumentasi mendalam.
Dokumentasi repositori ini sepenuhnya dihasilkan oleh Jotbot menggunakan gpt-4 tetapi saat ini (2023/07/18) Saya mendapatkan hasil terbaik menggunakan gpt-3.5-turbo .
Model gpt-3.5 dan gpt-4 Openai menunjukkan fluktuasi kualitas dari waktu ke waktu. Menentukan model mana yang unggul pada setiap contoh yang diberikan dapat menantang, tetapi gpt-4 sering menghasilkan hasil yang lebih konsisten.
Untuk aplikasi umum, saya sarankan menggunakan gpt-3.5-turbo-16k sebagai default, dan Temporarliy beralih ke gpt-4 dalam skenario di mana gpt-3.5 mungkin gagal.
gpt-4-1106-preview adalah model terbaik untuk menghasilkan dokumentasi sejauh ini. Model default Jotbot adalah gpt-3.5-turbo yang memberikan nilai terbaik untuk uang.
Anda dapat menemukan dokumentasi TypeScript yang dihasilkan dalam paket/jotbot.
go install github.com/modernice/jotbot/cmd/jotbot@latest
npm i -g jotbot-ts@latest
pnpm i -g jotbot-ts@latest
Dalam basis kode Go dan/atau TypeScript Anda, jalankan:
jotbot generate --key OPENAI_API_KEY
Jotbot menggunakan model GPT Openai untuk menghasilkan dokumentasi. Secara default, Jotbot menggunakan model gpt-3.5-turbo yang memberikan hasil yang baik pada tingkat yang hemat biaya. Namun, hasil terbaik diproduksi oleh gpt-4 dan text-davinci-003 , yang 10-30x lebih mahal daripada gpt-3.5-turbo .
Anda bebas memilih model apa pun dari dokumen OpenAI dan meneruskannya melalui --model|-m bendera:
jotbot generate -m text-davinci-003
go install Jika Anda telah diinstal, Anda dapat menginstal Jotbot menggunakan go install :
go install github.com/modernice/jotbot/cmd/jotbot@latest
Anda dapat mengunduh biner terbaru dari halaman rilis.
Untuk mengaktifkan dukungan TypeScript (dan JavaScript), Anda juga perlu menginstal paket NPM jotbot-ts .
npm install -g jotbot-ts
pnpm install -g jotbot-ts
Untuk menghasilkan dokumentasi yang hilang untuk basis kode Anda, jalankan perintah berikut:
jotbot generate [options]
Secara default, perintah ini akan menemukan semua file Go dan TypeScript (dan JavaScript) di direktori saat ini dan bersarang dan menghasilkan dokumentasi untuk mereka. Dikecualikan dari pencarian adalah secara default:
**/.*/****/dist/****/node_modules/****/vendor/****/testdata/****/test/****/tests/****/*.pb.go jotbot --help
| Pilihan | Keterangan | Bawaan |
|---|---|---|
--root | Direktori root dari repositori | "." |
--include, -i | Pola Glob untuk memasukkan file | |
--include-tests, -T | Sertakan fungsi testxxx () (go-spesifik) | |
--exclude, -e | Pola Glob untuk mengecualikan file | |
--exclude-internal, -E | Mengecualikan direktori 'internal' (go-spesifik) | true |
--match | Ekspresi reguler untuk mencocokkan pengidentifikasi | |
--symbol, -s | Simbol untuk mencari dalam kode (TS/JS khusus) | |
--clear, -c | KOMENTAR FORCE-CLEAR DALAM PROMED GENERASI (Go-Specific) | |
--branch | Nama cabang untuk melakukan perubahan pada (tinggalkan kosong untuk tidak berkomitmen) | |
--limit | Batasi jumlah file untuk menghasilkan dokumentasi | 0 |
--dry | Cetak perubahan tanpa menerapkannya | false |
--model, -m | Model OpenAI yang digunakan untuk menghasilkan dokumentasi | "gpt-3.5-turbo" |
--maxTokens | Jumlah token maksimum untuk menghasilkan dokumentasi tunggal | 512 |
--parallel, -p | Jumlah file yang harus ditangani secara bersamaan | 4 |
--workers | Jumlah pekerja untuk digunakan per file | 2 |
--override, -o | Mengesampingkan dokumentasi yang ada (go-spesifik) | |
--key | Kunci API Openai | |
--verbose, -v | Aktifkan logging verbose | false |
Mit
