Téléchargement AutoDoc ChatGPT - Téléchargement du code source AutoDoc ChatGPT

AutoDoc ChatGPT

Autre code source

Autodoc-ChatGPT 1.0

Télécharger

Autodoc-chatpt

Autodoc-chatGpt est un script Python qui tire parti de la puissance du modèle Chatgpt pour générer automatiquement la documentation pour tout langage de programmation.

Avec Autodoc-chatGPT, vous pouvez facilement générer une documentation complète pour votre base de code. Fournissez simplement le chemin du fichier que vous souhaitez documenter, et Autodoc-chatGPT générera une description détaillée de ses fonctionnalités, paramètres et valeurs de retour en langage naturel.

Commencer

Installation

Clone ce référentiel à votre machine locale:

git clone https://github.com/awekrx/AutoDoc-ChatGPT.git

Ensuite, installez les packages requis:

pip install -r requirements.txt

Langages de programmation pris en charge

Et d'autres ...

disclaimer : TypeScript et Javscript ont des bogues et est sous test
disclaimer_2.0 : Il y a une erreur connue commentant des fichiers avec 2 classes ou plus qui ont des méthodes avec le même nom.

Usage

Modifier la configuration

Ouvrez config.ini et ajoutez email et password si vous n'utilisez pas l'autorisation OAuth. Sinon, ouvrez Chatgpt et obtenez le cookie __Secure-next-auth.session-token et écrivez-le sur la session-token .

Commencer

py main.py -file " path to the file "

Le chemin d'accès au fichier peut être relatif ou absolu.

Après l'exécution, le fichier yourfilename_commented.language est créé dans le dossier avec le fichier souhaité.

OU

py main.py -file " path to the file "

Non recommandé, peu testé. Vous pouvez spécifier un fichier avec une option de commentaire pour créer de tels commentaires.

Exemple d'utilisation

Aperçu de l'utilisation

Utilisation alternative

Vous pouvez également l'utiliser comme une fonction dans Python.

 from modules . autodoc import AutoDoc
import configparser

config = configparser . ConfigParser ()
config . read ( "config.ini" )

auth = {
    "email" : config [ "ChatGPT" ][ "email" ],
    "password" : config [ "ChatGPT" ][ "password" ],
    "session_token" : config [ "ChatGPT" ][ "session_token" ]
}

result = AutoDoc (
        auth ,
        "Code for commenting" ,
        "language code" ,
        "example comment model (optional)"
    ). start ()
print ( result )
# out: Code with comments

Clause de non-responsabilité

Ne crée pas toujours des commentaires corrects. Cela ne signifie pas toujours ce que vous voulez. Utilisez comme un projet de commentaires qui peuvent devoir être modifiés.