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

العثور على مزيد من المعلومات حول التكوين هنا

مفتاح واجهة برمجة التطبيقات

أضف ملف .env في الدليل الجذر الخاص بك باستخدام OPENAI_API_KEY

أو قم بتعيين OPENAI_API_KEY كمتغير لبيئة النظام.

ابحث عن مفتاح API الخاص بك هنا

توثيق هذا المشروع

سيؤدي تشغيل docself في الريبو المستنسخ إلى توثيق الملفات المصدر بتنسيق ./src/

npm run docself

سيؤدي تشغيل test في الريبو المستنسخ إلى توثيق ./example/example.js

npm run test 

المساهمة

النقد البناء والقضايا والعلاقات العامة هي موضع ترحيب كبير!

---

ترخيص معهد ماساتشوستس للتكنولوجيا