Download gptdoc - download do código-fonte gptdoc

gptdoc

Outro código-fonte

v1.0.9

Baixar

Logotipo do GPTDoc

Gere comentários de documentação com modelos OpenAI

Instalar • Documentação • Licença

Visualização

Funções rotuladas com /** @gpt */ obtêm um comentário de documento gerado automaticamente

Antes

Depois

 /** @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 no projeto

Instale gptdoc como uma dependência de desenvolvimento

npm i --save-dev gptdoc

Executar

node node_modules/gptdoc [args]

Configuração

Você pode especificar um arquivo de configuração:

node node_modules/gptdoc -c .myconfig

Se nenhum for fornecido, o script procurará .gptdoc

Exemplo de arquivo de configuração

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