Descargar gptdoc - Descarga del código fuente gptdoc

gptdoc

Otro código fuente

v1.0.9

Descargar

Logotipo de GPTDoc

Generar comentarios de documentación con modelos OpenAI

Instalar • Documentación • Licencia

Avance

Las funciones etiquetadas con /** @gpt */ obtienen un comentario de documento generado automáticamente

Antes

Despué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 } ` ) ;
}

Instalar en proyecto

Instale gptdoc como una dependencia de desarrollo

npm i --save-dev gptdoc

Ejecutar

node node_modules/gptdoc [args]

configuración

Puede especificar un archivo de configuración:

node node_modules/gptdoc -c .myconfig

Si no se proporciona ninguno, el script buscará .gptdoc

Archivo de configuración de muestra

{
    "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 "
    }
}