jotbot
v0.1.5
JotBot generiert die Code-Dokumentation für Ihre GO- und Typscript-Projekte nahtlos automatisch und schließt die Lücke zwischen umfassenden Code und aufschlussreiche Dokumentation.
Die Dokumentation dieses Repositorys wurde von JOTBOT mit gpt-4 vollständig generiert, aber derzeit (2023/07/18) erhalte ich die besten Ergebnisse mit gpt-3.5-turbo .
OpenAIs Modelle gpt-3.5 und gpt-4 Modelle zeigen im Laufe der Zeit Schwankungen in der Qualität. Das Bestimmen, welches Modell in einer bestimmten Instanz hervorragend ist, kann eine Herausforderung sein, aber gpt-4 liefert häufig konsistentere Ergebnisse.
Für allgemeine Anwendungen empfehle ich die Verwendung gpt-3.5-turbo-16k als Standard und Temporarliy, der in Szenarien auf gpt-4 wechselt, in denen gpt-3.5 möglicherweise zu kurz kommen.
gpt-4-1106-preview ist das beste Modell zur Generierung von Dokumentationen. Das Standardmodell von Jotbot ist gpt-3.5-turbo , das das beste Preis-Leistungs-Verhältnis bietet.
Sie können generierte Typscript -Dokumentation in Paketen/Jotbot finden.
go install github.com/modernice/jotbot/cmd/jotbot@latest
npm i -g jotbot-ts@latest
pnpm i -g jotbot-ts@latest
Rennen Sie in Ihrem GO und/oder der Typscript -Codebasis:
jotbot generate --key OPENAI_API_KEY
Jotbot verwendet die GPT -Modelle von OpenAI, um Dokumentation zu generieren. Standardmäßig verwendet Jotbot das gpt-3.5-turbo Modell, das gute Ergebnisse zu einer kostengünstigen Geschwindigkeit liefert. Die besten Ergebnisse werden jedoch von gpt-4 und text-davinci-003 produziert, die 10-30x teurer sind als gpt-3.5-turbo .
Sie können ein Modell aus den OpenAI-Dokumenten auswählen und über das --model|-m Flag übergeben:
jotbot generate -m text-davinci-003
go install Wenn Sie GO installiert haben, können Sie Jotbot einfach mit go install installieren:
go install github.com/modernice/jotbot/cmd/jotbot@latest
Sie können die neueste Binärdatei von der Seite "Releases" herunterladen.
Um die Unterstützung von TypeScript (und JavaScript) zu aktivieren, müssen Sie auch das jotbot-ts NPM-Paket installieren.
npm install -g jotbot-ts
pnpm install -g jotbot-ts
Führen Sie den folgenden Befehl aus, um fehlende Dokumentationen für Ihre Codebasis zu generieren:
jotbot generate [options]
Standardmäßig werden in diesem Befehl alle GO- und TypeScript- (und JavaScript) -Dateien in den aktuellen und verschachtelten Verzeichnissen gefunden und für sie Dokumentation generiert. Aus der Suche ausgeschlossen sind standardmäßig:
**/.*/****/dist/****/node_modules/****/vendor/****/testdata/****/test/****/tests/****/*.pb.go jotbot --help
| Option | Beschreibung | Standard |
|---|---|---|
--root | Stammverzeichnis des Repositorys | "." |
--include, -i | GLID -Muster (en) Dateien einbeziehen | |
--include-tests, -T | TESTXXX () -Funktionen einschließen (GO-spezifisch) | |
--exclude, -e | GLID -Muster (en), um Dateien auszuschließen | |
--exclude-internal, -E | "Interne" Verzeichnisse ausschließen (GO-spezifisch) | true |
--match | Regelmäßige Ausdruck (en), um Identifikatoren zu entsprechen | |
--symbol, -s | Symbol (en), nach dem in Code (TS/JS-spezifisch) gesucht werden muss, nach | |
--clear, -c | Force-Clear-Kommentare in der Generation-Eingabeaufforderung (GO-spezifisch) | |
--branch | Zweigname, um Änderungen zu begehen (lassen Sie leer, um sich nicht zu verpflichten) | |
--limit | Beschränken Sie die Anzahl der Dateien, um Dokumentation für zu generieren | 0 |
--dry | Drucken Sie die Änderungen aus, ohne sie anzuwenden | false |
--model, -m | OpenAI -Modell zur Erstellung von Dokumentation | "gpt-3.5-turbo" |
--maxTokens | Maximale Anzahl von Token, die für eine einzige Dokumentation generiert werden sollen | 512 |
--parallel, -p | Anzahl der Dateien, die gleichzeitig verarbeiten können | 4 |
--workers | Anzahl der Arbeitnehmer, die pro Datei verwendet werden sollen | 2 |
--override, -o | Vorhandene Dokumentation überschreiben (GO-spezifisch) | |
--key | OpenAI -API -Schlüssel | |
--verbose, -v | Aktivieren Sie die ausführliche Protokollierung | false |
MIT
