gptdoc

Generieren Sie Dokumentationskommentare mit OpenAI-Modellen

Installieren Sie • Dokumentation • Lizenz

Vorschau

Mit /** @gpt */ gekennzeichnete Funktionen erhalten einen automatisch generierten Dokumentkommentar

Vor	Nach
/** @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 } ` ) ; }

Im Projekt installieren

Installieren Sie gptdoc als Entwicklungsabhängigkeit

npm i --save-dev gptdoc 

Ausführen

node node_modules/gptdoc [args]

Konfig

Sie können eine Konfigurationsdatei angeben:

node node_modules/gptdoc -c .myconfig

Wenn keine Angabe erfolgt, sucht das Skript nach .gptdoc

Beispielkonfigurationsdatei

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

Weitere Informationen zur Konfiguration finden Sie hier

API-Schlüssel

Fügen Sie mit OPENAI_API_KEY eine .env Datei in Ihrem Stammverzeichnis hinzu

oder legen Sie OPENAI_API_KEY als Systemumgebungsvariable fest.

Hier finden Sie Ihren API-Schlüssel

Dokumentieren Sie dieses Projekt

Wenn Sie docself im geklonten Repo ausführen, werden Quelldateien in ./src/ dokumentiert.

npm run docself

Wenn Sie test im geklonten Repo ausführen, wird ./example/example.js dokumentiert

npm run test 

Mitwirken

Konstruktive Kritik, Probleme und PRs sind herzlich willkommen!

---

Lizenz MIT