Infusi v.0

Sejak 2 minggu yang lalu, saya telah mengusahakan alat penjanaan dokumentasi yang menggunakan Open AI API untuk menjana fail baharu dengan dokumentasi di dalamnya. Saya telah membinanya menggunakan perpustakaan Python, Klik dan LangChain. Ciri-cirinya termasuk:

• Menjana ulasan dan dokumentasi berstruktur secara automatik untuk kod sumber.
• Menyokong berbilang bahasa pengaturcaraan (dikenal pasti melalui sambungan fail).
• Mengendalikan berbilang fail serentak (belum ada pemprosesan kelompok).
• Membenarkan direktori output tersuai untuk menyimpan fail yang diproses.
• Membolehkan anda menentukan model untuk digunakan.

Anda boleh mengakses repo GitHub di sini:
https://github.com/SychAndrii/infusion

Infusi ialah alat baris arahan yang direka untuk membantu pembangun dengan menjana dokumentasi untuk kod sumber mereka. Dengan menyediakan laluan fail, Infusion memanfaatkan model bahasa seperti GPT OpenAI untuk mengubah suai fail dengan memasukkan ulasan dan dokumentasi yang sesuai. Alat ini menyokong berbilang bahasa pengaturcaraan.

Ia amat berguna apabila anda memerlukan ulasan berstruktur (cth., JSDoc untuk JavaScript/TypeScript atau JavaDoc untuk Java) atau ulasan ringkas di atas fungsi dan kelas. Infusi menyimpan fail yang diubah suai ke direktori output yang ditentukan.

Pemasangan

Untuk memasang dan menjalankan Infusion secara setempat, klon repositori GitHub.

git clone https://github.com/your-username/infusion.git
cd infusion

Selepas itu, anda perlu menyediakan persekitaran maya dan memasang semua kebergantungan.

Jika anda menggunakan Windows, gunakan PowerShell untuk menyediakan persekitaran maya menggunakan arahan:

./setup/setup.ps1

Jika anda menggunakan Mac / Linux, gunakan arahan berikut:

./setup/setup.sh

Selepas anda selesai menyediakan persekitaran maya, anda boleh menggunakan alat Infusion dengan menjalankan:

pipenv run infsue [OPTIONS] [FILE_PATHS]...

Penggunaan

Untuk menggunakan Infusion, jalankan arahan berikut, menggantikan FILE_PATHS dengan laluan ke fail kod sumber yang anda mahu proses.

Proses satu fail:

pipenv run infsue ./path/to/source.py

Proses satu fail dengan model openAI yang berbeza:

pipenv run infsue -m gpt-4o-mini ./path/to/source.py

Proses satu fail dan tentukan folder output:

pipenv run infsue ./path/to/source.py --output my_output_folder

Proses berbilang fail:

pipenv run infsue ./file1.js ./file2.py

Proses berbilang fail tanpa menyatakan setiap satu daripadanya:

pipenv run infsue ./folder/*

Proses berbilang fail dan tentukan folder output untuk menyimpan fail dan bukannya mencetaknya ke stdout:

pipenv run infsue ./file1.js ./file2.py --output my_output_folder

Untuk contoh penggunaan alat ini yang lebih praktikal, sila lihat repositori GitHub! Saya suka jika anda menyiarkan isu anda untuk mencadangkan sebarang peningkatan dalam pangkalan kod saya!

Atas ialah kandungan terperinci Infusi v.0. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!