gptdocダウンロード - gptdocソースコードのダウンロード

gptdoc

その他のソースコード

v1.0.9

ダウンロード

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 "
    }
}