jotbot
v0.1.5
JotBot génère automatiquement la documentation de code pour vos projets Go et TypeScript, combler l'écart entre le code complet et la documentation perspicace.
La documentation de ce référentiel a été entièrement générée par Jotbot en utilisant gpt-4 mais actuellement (2023/07/18), j'obtiens les meilleurs résultats en utilisant gpt-3.5-turbo .
Les modèles gpt-3.5 et gpt-4 d'OpenAI montrent des fluctuations de qualité au fil du temps. Déterminer quel modèle excelle dans une instance donnée peut être difficile, mais gpt-4 donne souvent des résultats plus cohérents.
Pour les applications générales, je recommande d'utiliser gpt-3.5-turbo-16k par défaut, et temporaire le passage à gpt-4 dans les scénarios où gpt-3.5 pourrait échouer.
gpt-4-1106-preview est le meilleur modèle de génération de documentation jusqu'à présent. Le modèle par défaut de Jotbot est gpt-3.5-turbo qui donne le meilleur rapport qualité-prix.
Vous pouvez trouver la documentation TypeScript générée dans Packages / Jotbot.
go install github.com/modernice/jotbot/cmd/jotbot@latest
npm i -g jotbot-ts@latest
pnpm i -g jotbot-ts@latest
Dans votre base de code Go et / ou TypeScript, exécutez:
jotbot generate --key OPENAI_API_KEY
Jotbot utilise les modèles GPT d'Openai pour générer de la documentation. Par défaut, Jotbot utilise le modèle gpt-3.5-turbo qui fournit de bons résultats à un taux rentable. Cependant, les meilleurs résultats sont produits par gpt-4 et text-davinci-003 , qui sont 10-30x plus chers que gpt-3.5-turbo .
Vous êtes libre de choisir n'importe quel modèle parmi les documents Openai et de le passer via le --model|-m Flag:
jotbot generate -m text-davinci-003
go install Si vous avez installé, vous pouvez simplement installer Jotbot en utilisant go install :
go install github.com/modernice/jotbot/cmd/jotbot@latest
Vous pouvez télécharger le dernier binaire à partir de la page des versions.
Pour activer la prise en charge de TypeScript (et JavaScript), vous devez également installer le package NPM jotbot-ts .
npm install -g jotbot-ts
pnpm install -g jotbot-ts
Pour générer une documentation manquante pour votre base de code, exécutez la commande suivante:
jotbot generate [options]
Par défaut, cette commande trouvera tous les fichiers GO et TypeScript (et JavaScript) dans les répertoires actuels et imbriqués et générer des documents pour eux. Exclu de la recherche sont par défaut:
**/.*/****/dist/****/node_modules/****/vendor/****/testdata/****/test/****/tests/****/*.pb.go jotbot --help
| Option | Description | Défaut |
|---|---|---|
--root | Répertoire racine du référentiel | "." |
--include, -i | Modèle glob (s) pour inclure des fichiers | |
--include-tests, -T | Inclure les fonctions testxxx () (spécifique au GO) | |
--exclude, -e | Modèle glob (s) pour exclure les fichiers | |
--exclude-internal, -E | Exclure les répertoires «internes» (spécifique au GO) | true |
--match | Expression régulière pour correspondre aux identifiants | |
--symbol, -s | Symbole (s) à rechercher dans Code (TS / JS-spécifique) | |
--clear, -c | Commentaires clairs dans Generation Invite (spécifique au GO) | |
--branch | Nom de la branche pour commettre des modifications (laisser vide pour ne pas s'engager) | |
--limit | Limitez le nombre de fichiers pour générer de la documentation pour | 0 |
--dry | Imprimez les modifications sans les appliquer | false |
--model, -m | Modèle OpenAI utilisé pour générer de la documentation | "gpt-3.5-turbo" |
--maxTokens | Nombre maximum de jetons à générer pour une seule documentation | 512 |
--parallel, -p | Nombre de fichiers à gérer simultanément | 4 |
--workers | Nombre de travailleurs à utiliser par fichier | 2 |
--override, -o | Remplacer la documentation existante (spécifique au GO) | |
--key | Clé API Openai | |
--verbose, -v | Activer la journalisation verbeuse | false |
Mit
