gpt-doc-gen 是一个命令行界面 (CLI) 工具，用于使用 OpenAI 的 Dali 语言模型生成 Rust 文档注释。它将文档化所有公共项，包括添加示例、# 错误 部分，以及从其他 crate 链接类型。

安装

cargo install gpt-doc-gen

或者本地构建二进制文件

git clone [email protected]/kaiserkarel/gpt-doc-gen
cd gpt-doc-gen
cargo install --path .

用法

CLI 参数仍然不稳定，可能会更改。

cargo gpt-doc-gen --help

--- 
gpt-doc-gen 0.1.0
A CLI to document Rust code

USAGE:
    gpt-doc-gen [FLAGS] --api-key <api-key> <SUBCOMMAND>

FLAGS:
    -d, --dryrun     Print the output to stdout instead of writing it to a file
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -a, --api-key <api-key>     [env: GPT_DOC_GEN_API_KEY=$API_KEY]

SUBCOMMANDS:
    document-crate    Add doc comments to all Rust files in a crate
    document-file     Add doc comments to a single file
    help              Prints this message or the help of the given subcommand(s)

gpt-doc-gen 可以为特定文件添加文档，