Téléchargement gptdoc - Téléchargement du code source gptdoc

gptdoc

Autre code source

v1.0.9

Télécharger

Logo GPTDoc

Générez des commentaires de documentation avec les modèles OpenAI

Installer • Documentation • Licence

Aperçu

Les fonctions étiquetées avec /** @gpt */ obtiennent un commentaire de document généré automatiquement

Avant

Après

 /** @gpt */
function Greet ( name ) {
    console . log ( `Hello ${ name } ` ) ;
}

 /**
 * @autogenerated
 * @summary Generates a greeting to the passed in name
 * @param {string} name - The name to greet
 */
function Greet ( name ) {
    console . log ( `Hello ${ name } ` ) ;
}

Installer dans le projet

Installer gptdoc en tant que dépendance de développement

npm i --save-dev gptdoc

Exécuter

node node_modules/gptdoc [args]

Configuration

Vous pouvez spécifier un fichier de configuration :

node node_modules/gptdoc -c .myconfig

Si aucun n'est fourni, le script recherchera .gptdoc

Exemple de fichier de configuration

{
    "DEBUG" : false ,
    "framework" : " JSDOC " ,
    "language" : " JS " ,
    "files" : {
        "src" : " ./src " ,
        "dest" : " ./gpt "
    },
    "openai" : {
        "temperature" : 0.7 ,
        "top_p" : 1 ,
        "max_tokens" : 256 ,
        "model" : " text-davinci-003 "
    }
}