jotbot
v0.1.5
JotBot无缝自动生成您的GO和打字稿项目的代码文档，从而弥合了综合代码和有见地的文档之间的差距。
该存储库的文档完全由Jotbot使用gpt-4生成，但目前（2023/07/18）我使用gpt-3.5-turbo获得了最佳结果。
OpenAI的gpt-3.5和gpt-4模型随着时间的推移表现出质量的波动。确定哪种模型在任何给定的实例上都可能具有挑战性，但是gpt-4通常会产生更一致的结果。
对于一般应用，我建议将gpt-3.5-turbo-16k用作默认设置，而在gpt-3.5可能不足的情况下，临时切换到gpt-4 。
gpt-4-1106-preview是迄今为止生成文档的最佳模型。 Jotbot的默认模型是gpt-3.5-turbo ，它具有最佳价值。
您可以在packages/jotbot中找到生成的打字稿文档。
go install github.com/modernice/jotbot/cmd/jotbot@latest
npm i -g jotbot-ts@latest
pnpm i -g jotbot-ts@latest
在您的Go和/或Typescript代码库中，运行：
jotbot generate --key OPENAI_API_KEY
Jotbot利用OpenAI的GPT模型来生成文档。默认情况下，Jotbot使用gpt-3.5-turbo模型，该模型以具有成本效益的速度提供良好的结果。但是，最好的结果是由gpt-4和text-davinci-003产生的，它们比gpt-3.5-turbo贵10-30倍。
您可以自由从OpenAI文档中选择任何模型，并通过--model|-m标志传递。
jotbot generate -m text-davinci-003
go install如果您已经安装了，则只需使用go install安装Jotbot：
go install github.com/modernice/jotbot/cmd/jotbot@latest
您可以从“发行版”页面下载最新的二进制文件。
要启用打字稿（和JavaScript）支持，您还需要安装jotbot-ts NPM软件包。
npm install -g jotbot-ts
pnpm install -g jotbot-ts
要为您的代码库生成丢失的文档，请运行以下命令：
jotbot generate [options]
默认情况下，此命令将在当前和嵌套目录中找到所有GO和Typecript（和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特定于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 |
麻省理工学院
