gptdoc

使用 OpenAI 模型生成文档注释

安装 • 文档 • 许可证

预览

标有/** @gpt */的函数获取自动生成的文档注释

前	后
/** @gpt */ function Greet ( name ) { console . log ( `Hello ${ name } ` ) ; }	/** * @autogenerated * @summary Generates a greeting to the passed in name * @param {string} name - The name to greet */ function Greet ( name ) { console . log ( `Hello ${ name } ` ) ; }

安装在项目中

安装gptdoc作为开发依赖项

npm i --save-dev gptdoc 

执行

node node_modules/gptdoc [args]

配置

您可以指定一个配置文件：

node node_modules/gptdoc -c .myconfig

如果没有提供，脚本将查找.gptdoc

示例配置文件

{
    "DEBUG" : false ,
    "framework" : " JSDOC " ,
    "language" : " JS " ,
    "files" : {
        "src" : " ./src " ,
        "dest" : " ./gpt "
    },
    "openai" : {
        "temperature" : 0.7 ,
        "top_p" : 1 ,
        "max_tokens" : 256 ,
        "model" : " text-davinci-003 "
    }
}

在此处查找有关配置的更多信息

API密钥

使用OPENAI_API_KEY在根目录中添加.env文件

或者将OPENAI_API_KEY设置为系统环境变量。

在这里找到您的 API 密钥

记录该项目

在克隆的存储库中运行docself将在./src/中记录源文件

npm run docself

在克隆的存储库中运行test将记录./example/example.js

npm run test 

贡献

我们非常欢迎建设性的批评、问题和 PR！

---

许可麻省理工学院