jotbot
v0.1.5
JotBot Documentação de código de geração automática perfeitamente para seus projetos GO e TypeScript, preenchendo a lacuna entre código abrangente e documentação perspicaz.
A documentação deste repositório foi inteiramente gerada pelo JOTBOT usando gpt-4 , mas atualmente (2023/07/18) Recebo os melhores resultados usando gpt-3.5-turbo .
Os modelos gpt-3.5 e gpt-4 do OpenAI demonstram flutuações de qualidade ao longo do tempo. Determinar qual modelo se destaca em qualquer instância pode ser desafiador, mas gpt-4 geralmente produz resultados mais consistentes.
Para aplicações gerais, recomendo o uso gpt-3.5-turbo-16k como padrão, e a mudança temporária para gpt-4 em cenários em que gpt-3.5 pode ficar aquém.
gpt-4-1106-preview é o melhor modelo para gerar documentação até agora. O modelo padrão do JOTBOT é gpt-3.5-turbo , que é o melhor valor pelo dinheiro.
Você pode encontrar a documentação do TypeScript gerado em pacotes/JOTBOT.
go install github.com/modernice/jotbot/cmd/jotbot@latest
npm i -g jotbot-ts@latest
pnpm i -g jotbot-ts@latest
Dentro da sua base de código GO e/ou TypeScript, execute:
jotbot generate --key OPENAI_API_KEY
O Jotbot utiliza os modelos GPT da OpenAI para gerar documentação. Por padrão, o Jotbot usa o modelo gpt-3.5-turbo , que fornece bons resultados a uma taxa econômica. No entanto, os melhores resultados são produzidos pelo gpt-4 e text-davinci-003 , que são 10-30x mais caros que gpt-3.5-turbo .
Você é livre para escolher qualquer modelo no Docs OpenAI e passá-lo através do sinalizador --model|-m :
jotbot generate -m text-davinci-003
go install Se você foi instalado, basta instalar o Jotbot usando go install :
go install github.com/modernice/jotbot/cmd/jotbot@latest
Você pode baixar a página mais recente do binário na página de lançamentos.
Para ativar o suporte ao TypeScript (e JavaScript), você também precisa instalar o pacote jotbot-ts NPM.
npm install -g jotbot-ts
pnpm install -g jotbot-ts
Para gerar documentação ausente para sua base de código, execute o seguinte comando:
jotbot generate [options]
Por padrão, este comando encontrará arquivos GO e TypeScript (e JavaScript) nos diretórios atuais e aninhados e gerará documentação para eles. Excluído da pesquisa são por padrão:
**/.*/****/dist/****/node_modules/****/vendor/****/testdata/****/test/****/tests/****/*.pb.go jotbot --help
| Opção | Descrição | Padrão |
|---|---|---|
--root | Diretório raiz do repositório | "." |
--include, -i | Padrões globais para incluir arquivos | |
--include-tests, -T | Incluir funções testxxx () (específico para Go) | |
--exclude, -e | Padrões Glob (s) para excluir arquivos | |
--exclude-internal, -E | Exclua diretórios 'internos' (específicos para Go) | true |
--match | Expressão regular (s) para corresponder aos identificadores | |
--symbol, -s | Símbolo (s) a serem pesquisados no código (TS/JS específico) | |
--clear, -c | Comentários com limpeza de força no prompt de geração (específico) | |
--branch | Nome da filial para cometer alterações (deixe vazio para não se comprometer) | |
--limit | Limitar o número de arquivos para gerar documentação para | 0 |
--dry | Imprima as mudanças sem aplicá -las | false |
--model, -m | Modelo OpenAI usado para gerar documentação | "gpt-3.5-turbo" |
--maxTokens | Número máximo de tokens para gerar uma única documentação | 512 |
--parallel, -p | Número de arquivos para lidar simultaneamente | 4 |
--workers | Número de trabalhadores a serem usados por arquivo | 2 |
--override, -o | Substituir a documentação existente (específica do GO) | |
--key | Chave da API OpenAI | |
--verbose, -v | Habilite o registro verboso | false |
Mit
