jotbot
v0.1.5
JotBot genere automáticamente automáticamente la documentación del código para sus proyectos GO y TypeScript, cerrando la brecha entre el código integral y la documentación perspicaz.
La documentación de este repositorio fue generada por completo por JOTBOT usando gpt-4 pero actualmente (2023/07/18) obtengo los mejores resultados usando gpt-3.5-turbo .
Los modelos gpt-3.5 y gpt-4 de OpenAI demuestran fluctuaciones en la calidad con el tiempo. Determinar qué modelo sobresale en cualquier caso dado puede ser un desafío, pero gpt-4 a menudo produce resultados más consistentes.
Para aplicaciones generales, recomiendo usar gpt-3.5-turbo-16k como un valor predeterminado, y el cambio temporal a gpt-4 en escenarios donde gpt-3.5 podría quedarse corto.
gpt-4-1106-preview es el mejor modelo para generar documentación hasta ahora. El modelo predeterminado de JOTBOT es gpt-3.5-turbo , que ofrece la mejor relación calidad-precio.
Puede encontrar la documentación de TypeScript generada en paquetes/jotbot.
go install github.com/modernice/jotbot/cmd/jotbot@latest
npm i -g jotbot-ts@latest
pnpm i -g jotbot-ts@latest
Dentro de su base de código GO y/o TypeScript, ejecute:
jotbot generate --key OPENAI_API_KEY
JOTBOT utiliza los modelos GPT de OpenAI para generar documentación. Por defecto, JOTBOT utiliza el modelo gpt-3.5-turbo que proporciona buenos resultados a una tarifa rentable. Sin embargo, los mejores resultados son producidos por gpt-4 y text-davinci-003 , que son 10-30x más caros que gpt-3.5-turbo .
Usted es libre de elegir cualquier modelo de los documentos de Operai y pasarlo a través de la bandera --model|-m :
jotbot generate -m text-davinci-003
go install Si ha instalado, simplemente puede instalar JotBot usando go install :
go install github.com/modernice/jotbot/cmd/jotbot@latest
Puede descargar el último binario de la página de lanzamientos.
Para habilitar el soporte de TypeScript (y JavaScript), también debe instalar el paquete jotbot-ts NPM.
npm install -g jotbot-ts
pnpm install -g jotbot-ts
Para generar documentación faltante para su base de código, ejecute el siguiente comando:
jotbot generate [options]
Por defecto, este comando encontrará todos los archivos GO y TypeScript (y JavaScript) en los directorios actuales y anidados y generará documentación para ellos. Excluidos de la búsqueda son de forma predeterminada:
**/.*/****/dist/****/node_modules/****/vendor/****/testdata/****/test/****/tests/****/*.pb.go jotbot --help
| Opción | Descripción | Por defecto |
|---|---|---|
--root | Directorio raíz del repositorio | "." |
--include, -i | Patrón (s) de Glob para incluir archivos | |
--include-tests, -T | Incluir funciones testxxx () (específicas de GO) | |
--exclude, -e | Patrón (s) de Glob para excluir archivos | |
--exclude-internal, -E | Excluir directorios 'internos' (específico de GO) | true |
--match | Expresión (s) regular (s) para que coincidan con identificadores | |
--symbol, -s | Símbolo (s) para buscar en el código (TS/JS específico) | |
--clear, -c | Comentarios de Force-Clare en el aviso de generación (específico de GO) | |
--branch | Nombre de la rama para comprometer cambios a (dejar vacío para no comprometerse) | |
--limit | Limite el número de archivos para generar documentación para | 0 |
--dry | Imprima los cambios sin aplicarlos | false |
--model, -m | Modelo Operai utilizado para generar documentación | "gpt-3.5-turbo" |
--maxTokens | Número máximo de tokens para generar para una sola documentación | 512 |
--parallel, -p | Número de archivos para manejar simultáneamente | 4 |
--workers | Número de trabajadores para usar por archivo | 2 |
--override, -o | Anular la documentación existente (específica de GO) | |
--key | Clave de API de OpenAI | |
--verbose, -v | Habilitar el registro verboso | false |
MIT
