Im Laufe der letzten 2 Wochen habe ich an einem Tool zur Dokumentationserstellung gearbeitet, das Open AI API verwendet, um neue Dateien mit Dokumentation zu generieren. Ich habe es mit Python-, Click- und LangChain-Bibliotheken erstellt. Zu den Funktionen gehören:
Sie können hier auf das GitHub-Repo zugreifen:
https://github.com/SychAndrii/infusion
Infusion ist ein Befehlszeilentool, das Entwickler bei der Erstellung von Dokumentationen für ihren Quellcode unterstützen soll. Durch die Bereitstellung von Dateipfaden nutzt Infusion Sprachmodelle wie GPT von OpenAI, um die Dateien durch Einfügen entsprechender Kommentare und Dokumentation zu ändern. Das Tool unterstützt mehrere Programmiersprachen.
Es ist besonders nützlich, wenn Sie strukturierte Kommentare (z. B. JSDoc für JavaScript/TypeScript oder JavaDoc für Java) oder einfache Kommentare über Funktionen und Klassen benötigen. Infusion speichert die geänderten Dateien in einem angegebenen Ausgabeverzeichnis.
Um Infusion lokal zu installieren und auszuführen, klonen Sie das GitHub-Repository.
git clone https://github.com/your-username/infusion.git cd infusion
Danach müssen Sie eine virtuelle Umgebung einrichten und alle Abhängigkeiten installieren.
Wenn Sie Windows verwenden, verwenden Sie PowerShell, um eine virtuelle Umgebung mit dem folgenden Befehl einzurichten:
./setup/setup.ps1
Wenn Sie Mac / Linux verwenden, verwenden Sie den folgenden Befehl:
./setup/setup.sh
Nachdem Sie mit der Einrichtung der virtuellen Umgebung fertig sind, können Sie das Infusion-Tool verwenden, indem Sie Folgendes ausführen:
pipenv run infsue [OPTIONS] [FILE_PATHS]...
Um Infusion zu verwenden, führen Sie den folgenden Befehl aus und ersetzen Sie FILE_PATHS durch die Pfade zu den Quellcodedateien, die Sie verarbeiten möchten.
Eine einzelne Datei verarbeiten:
pipenv run infsue ./path/to/source.py
Verarbeiten Sie eine einzelne Datei mit einem anderen openAI-Modell:
pipenv run infsue -m gpt-4o-mini ./path/to/source.py
Verarbeiten Sie eine einzelne Datei und geben Sie einen Ausgabeordner an:
pipenv run infsue ./path/to/source.py --output my_output_folder
Mehrere Dateien verarbeiten:
pipenv run infsue ./file1.js ./file2.py
Verarbeiten Sie mehrere Dateien, ohne jede einzelne davon anzugeben:
pipenv run infsue ./folder/*
Verarbeiten Sie mehrere Dateien und geben Sie einen Ausgabeordner an, in dem die Dateien gespeichert werden sollen, anstatt sie auf stdout zu drucken:
pipenv run infsue ./file1.js ./file2.py --output my_output_folder
Ein praktischeres Beispiel für die Verwendung dieses Tools finden Sie im GitHub-Repository! Ich würde mich freuen, wenn Sie Ihr Problem posten und mir Verbesserungsvorschläge für meine Codebasis machen würden!
Das obige ist der detaillierte Inhalt vonInfusion v.0. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!
