Infusion v.0

Au cours des 2 dernières semaines, j'ai travaillé sur un outil de génération de documentation qui utilise l'API Open AI pour générer de nouveaux fichiers contenant de la documentation. Je l'ai construit en utilisant les bibliothèques Python, Click et LangChain. Les fonctionnalités incluent :

• Génère automatiquement des commentaires structurés et de la documentation pour le code source.
• Prend en charge plusieurs langages de programmation (identifiés via l'extension de fichier).
• Gère plusieurs fichiers à la fois (pas encore de traitement par lots).
• Permet aux répertoires de sortie personnalisés de stocker les fichiers traités.
• Vous permet de spécifier un modèle à utiliser.

Vous pouvez accéder au dépôt GitHub ici :
https://github.com/SychAndrii/infusion

Infusion est un outil de ligne de commande conçu pour aider les développeurs en générant de la documentation pour leur code source. En fournissant des chemins de fichiers, Infusion exploite des modèles de langage tels que le GPT d'OpenAI pour modifier les fichiers en insérant des commentaires et une documentation appropriés. L'outil prend en charge plusieurs langages de programmation.

C'est particulièrement utile lorsque vous avez besoin de commentaires structurés (par exemple, JSDoc pour JavaScript/TypeScript ou JavaDoc pour Java) ou de simples commentaires au-dessus des fonctions et des classes. Infusion enregistre les fichiers modifiés dans un répertoire de sortie spécifié.

Installation

Pour installer et exécuter Infusion localement, clonez le référentiel GitHub.

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

Après cela, vous devrez configurer un environnement virtuel et installer toutes les dépendances.

Si vous êtes sous Windows, utilisez PowerShell pour configurer l'environnement virtuel à l'aide de la commande :

./setup/setup.ps1

Si vous êtes sous Mac / Linux, utilisez la commande suivante :

./setup/setup.sh

Une fois la configuration de l'environnement virtuel terminée, vous pouvez utiliser l'outil Infusion en exécutant :

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

Usage

Pour utiliser Infusion, exécutez la commande suivante, en remplaçant FILE_PATHS par les chemins d'accès aux fichiers de code source que vous souhaitez traiter.

Traiter un seul fichier :

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

Traitez un seul fichier avec un modèle openAI différent :

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

Traitez un seul fichier et spécifiez un dossier de sortie :

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

Traiter plusieurs fichiers :

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

Traitez plusieurs fichiers sans les spécifier chacun :

pipenv run infsue ./folder/*

Traitez plusieurs fichiers et spécifiez un dossier de sortie dans lequel enregistrer les fichiers au lieu de les imprimer sur la sortie standard :

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

Pour un exemple plus pratique d'utilisation de cet outil, veuillez consulter le référentiel GitHub ! J'aimerais que vous publiiez votre problème pour suggérer des améliorations dans ma base de code !

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!