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！

---

許可麻省理工學院