jotbot
v0.1.5
JotBot легко создает документацию по коде для ваших проектов GO и TypeScript, преодолевая разрыв между комплексным кодом и проницательной документацией.
Документация этого репозитория была полностью сгенерирована Jotbot с использованием gpt-4 , но в настоящее время (2023/07/18) я получаю наилучшие результаты, используя gpt-3.5-turbo .
Модели OpenAI gpt-3.5 и gpt-4 демонстрируют колебания качества с течением времени. Определение того, какая модель превосходит в любом данном экземпляре, может быть сложным, но gpt-4 часто дает более последовательные результаты.
Для общих приложений я рекомендую использовать gpt-3.5-turbo-16k в качестве дефолта и временного перехода на gpt-4 в сценариях, где gpt-3.5 может терпеть неудачу.
gpt-4-1106-preview -лучшая модель для генерации документации. Модель JotBot по умолчанию- gpt-3.5-turbo , которая дает наилучшее соотношение цены и качества.
Вы можете найти сгенерированную документацию TypeScript в пакетах/Jotbot.
go install github.com/modernice/jotbot/cmd/jotbot@latest
npm i -g jotbot-ts@latest
pnpm i -g jotbot-ts@latest
В рамках кодовой базы TypeScript Code, запустите:
jotbot generate --key OPENAI_API_KEY
Jotbot использует модели GPT Openai для создания документации. По умолчанию Jotbot использует модель gpt-3.5-turbo , которая дает хорошие результаты с экономически эффективной скоростью. Тем не менее, наилучшие результаты дают gpt-4 и text-davinci-003 , которые в 10-30x дороже, чем gpt-3.5-turbo .
Вы можете выбрать любую модель из документов OpenAI и пройти ее через флаг --model|-m :
jotbot generate -m text-davinci-003
go install Если вы установили, вы можете просто установить jotbot с помощью go install :
go install github.com/modernice/jotbot/cmd/jotbot@latest
Вы можете скачать последний бинар с страницы релизов.
Чтобы включить поддержку TypeScript (и JavaScript), вам также необходимо установить пакет jotbot-ts NPM.
npm install -g jotbot-ts
pnpm install -g jotbot-ts
Чтобы сгенерировать пропущенную документацию для вашей кодовой базы, запустите следующую команду:
jotbot generate [options]
По умолчанию эта команда найдет все файлы GO и TypeScript (и JavaScript) в текущих и вложенных каталогах и генерирует для них документацию. Исключено из поиска по умолчанию:
**/.*/****/dist/****/node_modules/****/vendor/****/testdata/****/test/****/tests/****/*.pb.go jotbot --help
| Вариант | Описание | По умолчанию |
|---|---|---|
--root | Корневой каталог хранилища | "." |
--include, -i | Шаблоны глобуса для включения файлов | |
--include-tests, -T | Включите функции testxxx () (GO-специфический) | |
--exclude, -e | Шаблоны глобуса для исключения файлов | |
--exclude-internal, -E | Исключить «внутренние» каталоги (специфичные для GO) | true |
--match | Регулярное выражение (ы) для соответствия идентификаторам | |
--symbol, -s | Символ (ы) для поиска в коде (TS/JS-специфический) | |
--clear, -c | Комментарии с силой в приглашении на генерацию (спецификация GO) | |
--branch | Имя филиала, чтобы совершить изменения (оставьте пустым, чтобы не совершать) | |
--limit | Ограничить количество файлов для создания документации для | 0 |
--dry | Распечатайте изменения, не применяя их | false |
--model, -m | Модель OpenAI, используемая для генерации документации | "gpt-3.5-turbo" |
--maxTokens | Максимальное количество токенов для генерации для одной документации | 512 |
--parallel, -p | Количество файлов для выполнения одновременно | 4 |
--workers | Количество работников для использования в файле | 2 |
--override, -o | Переопределить существующую документацию (GO-специфический) | |
--key | OpenAI API -ключ | |
--verbose, -v | Включить многословную регистрацию | false |
Грань
